java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkPipelineMultisampleStateCreateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPipelineMultisampleStateCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created pipeline multisample state.
Valid Usage
- If the sample rate shading feature is not enabled, sampleShadingEnable must be FALSE
- If the alpha to one feature is not enabled, alphaToOneEnable must be FALSE
- minSampleShading must be in the range [0,1]
- If the VK_NV_framebuffer_mixed_samples extension is enabled, and if the subpass has any color attachments and rasterizationSamples is greater than the number of color samples, then sampleShadingEnable must be FALSE
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
- Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkPipelineCoverageModulationStateCreateInfoNV, VkPipelineCoverageReductionStateCreateInfoNV, VkPipelineCoverageToColorStateCreateInfoNV, or VkPipelineSampleLocationsStateCreateInfoEXT
- Each sType member in the pNext chain must be unique
- flags must be 0
- rasterizationSamples must be a valid VkSampleCountFlagBits value
- If pSampleMask is not NULL, pSampleMask must be a valid pointer to an array of ceil(rasterizationSamples / 32) VkSampleMask values
See Also

VkGraphicsPipelineCreateInfo

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – reserved for future use.
- rasterizationSamples – a VkSampleCountFlagBits specifying the number of samples used in rasterization.
- sampleShadingEnable – can be used to enable Sample Shading.
- minSampleShading – specifies a minimum fraction of sample shading if sampleShadingEnable is set to TRUE.
- pSampleMask – a bitmask of static coverage information that is ANDed with the coverage information generated during rasterization, as described in Sample Mask.
- alphaToCoverageEnable – controls whether a temporary coverage value is generated based on the alpha component of the fragment’s first color output as specified in the Multisample Coverage section.
- alphaToOneEnable – controls whether the alpha component of the fragment’s first color output is replaced with one as described in Multisample Coverage.
Layout
```
 struct VkPipelineMultisampleStateCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkPipelineMultisampleStateCreateFlags flags;
     VkSampleCountFlagBits rasterizationSamples;
     VkBool32 sampleShadingEnable;
     float minSampleShading;
     VkSampleMask const * pSampleMask;
     VkBool32 alphaToCoverageEnable;
     VkBool32 alphaToOneEnable;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkPipelineMultisampleStateCreateInfo.Buffer
An array of VkPipelineMultisampleStateCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`ALPHATOCOVERAGEENABLE ALPHATOONEENABLE FLAGS MINSAMPLESHADING PNEXT PSAMPLEMASK RASTERIZATIONSAMPLES SAMPLESHADINGENABLE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkPipelineMultisampleStateCreateInfo(java.nio.ByteBuffer container)`	Creates a `VkPipelineMultisampleStateCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`alphaToCoverageEnable()`	Returns the value of the `alphaToCoverageEnable` field.
`VkPipelineMultisampleStateCreateInfo`	`alphaToCoverageEnable(boolean value)`	Sets the specified value to the `alphaToCoverageEnable` field.
`boolean`	`alphaToOneEnable()`	Returns the value of the `alphaToOneEnable` field.
`VkPipelineMultisampleStateCreateInfo`	`alphaToOneEnable(boolean value)`	Sets the specified value to the `alphaToOneEnable` field.
`static VkPipelineMultisampleStateCreateInfo`	`calloc()`	Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated with `memCalloc`.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`calloc(int capacity)`	Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkPipelineMultisampleStateCreateInfo`	`callocStack()`	Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`callocStack(int capacity)`	Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineMultisampleStateCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineMultisampleStateCreateInfo`	`create()`	Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated with `BufferUtils`.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`create(int capacity)`	Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineMultisampleStateCreateInfo`	`create(long address)`	Returns a new `VkPipelineMultisampleStateCreateInfo` instance for the specified memory address.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`create(long address, int capacity)`	Create a `VkPipelineMultisampleStateCreateInfo.Buffer` instance at the specified memory.
`static VkPipelineMultisampleStateCreateInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	Returns the value of the `flags` field.
`VkPipelineMultisampleStateCreateInfo`	`flags(int value)`	Sets the specified value to the `flags` field.
`static VkPipelineMultisampleStateCreateInfo`	`malloc()`	Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated with `memAlloc`.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`malloc(int capacity)`	Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkPipelineMultisampleStateCreateInfo`	`mallocStack()`	Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`mallocStack(int capacity)`	Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineMultisampleStateCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineMultisampleStateCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated on the specified `MemoryStack`.
`float`	`minSampleShading()`	Returns the value of the `minSampleShading` field.
`VkPipelineMultisampleStateCreateInfo`	`minSampleShading(float value)`	Sets the specified value to the `minSampleShading` field.
`static int`	`nalphaToCoverageEnable(long struct)`	Unsafe version of `alphaToCoverageEnable()`.
`static void`	`nalphaToCoverageEnable(long struct, int value)`	Unsafe version of `alphaToCoverageEnable`.
`static int`	`nalphaToOneEnable(long struct)`	Unsafe version of `alphaToOneEnable()`.
`static void`	`nalphaToOneEnable(long struct, int value)`	Unsafe version of `alphaToOneEnable`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static float`	`nminSampleShading(long struct)`	Unsafe version of `minSampleShading()`.
`static void`	`nminSampleShading(long struct, float value)`	Unsafe version of `minSampleShading`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static java.nio.IntBuffer`	`npSampleMask(long struct, int capacity)`	Unsafe version of `pSampleMask`.
`static void`	`npSampleMask(long struct, java.nio.IntBuffer value)`	Unsafe version of `pSampleMask`.
`static int`	`nrasterizationSamples(long struct)`	Unsafe version of `rasterizationSamples()`.
`static void`	`nrasterizationSamples(long struct, int value)`	Unsafe version of `rasterizationSamples`.
`static int`	`nsampleShadingEnable(long struct)`	Unsafe version of `sampleShadingEnable()`.
`static void`	`nsampleShadingEnable(long struct, int value)`	Unsafe version of `sampleShadingEnable`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`long`	`pNext()`	Returns the value of the `pNext` field.
`VkPipelineMultisampleStateCreateInfo`	`pNext(long value)`	Sets the specified value to the `pNext` field.
`java.nio.IntBuffer`	`pSampleMask(int capacity)`	Returns a `IntBuffer` view of the data pointed to by the `pSampleMask` field.
`VkPipelineMultisampleStateCreateInfo`	`pSampleMask(java.nio.IntBuffer value)`	Sets the address of the specified `IntBuffer` to the `pSampleMask` field.
`int`	`rasterizationSamples()`	Returns the value of the `rasterizationSamples` field.
`VkPipelineMultisampleStateCreateInfo`	`rasterizationSamples(int value)`	Sets the specified value to the `rasterizationSamples` field.
`boolean`	`sampleShadingEnable()`	Returns the value of the `sampleShadingEnable` field.
`VkPipelineMultisampleStateCreateInfo`	`sampleShadingEnable(boolean value)`	Sets the specified value to the `sampleShadingEnable` field.
`VkPipelineMultisampleStateCreateInfo`	`set(int sType, long pNext, int flags, int rasterizationSamples, boolean sampleShadingEnable, float minSampleShading, java.nio.IntBuffer pSampleMask, boolean alphaToCoverageEnable, boolean alphaToOneEnable)`	Initializes this struct with the specified values.
`VkPipelineMultisampleStateCreateInfo`	`set(VkPipelineMultisampleStateCreateInfo src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	Returns the value of the `sType` field.
`VkPipelineMultisampleStateCreateInfo`	`sType(int value)`	Sets the specified value to the `sType` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- STYPE, PNEXT, FLAGS, RASTERIZATIONSAMPLES, SAMPLESHADINGENABLE, MINSAMPLESHADING, PSAMPLEMASK, ALPHATOCOVERAGEENABLE, ALPHATOONEENABLE
  
  The struct member offsets.

Constructor Detail
- VkPipelineMultisampleStateCreateInfo
```
public VkPipelineMultisampleStateCreateInfo(java.nio.ByteBuffer container)
```
  Creates a VkPipelineMultisampleStateCreateInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
  The created instance holds a strong reference to the container object.

Method Detail

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

sType
```
public int sType()
```
Returns the value of the sType field.

pNext
```
public long pNext()
```
Returns the value of the pNext field.

flags
```
public int flags()
```
Returns the value of the flags field.

rasterizationSamples
```
public int rasterizationSamples()
```
Returns the value of the rasterizationSamples field.

sampleShadingEnable
```
public boolean sampleShadingEnable()
```
Returns the value of the sampleShadingEnable field.

minSampleShading
```
public float minSampleShading()
```
Returns the value of the minSampleShading field.

pSampleMask
```
@Nullable
public java.nio.IntBuffer pSampleMask(int capacity)
```
Returns a IntBuffer view of the data pointed to by the pSampleMask field.

Parameters:

capacity - the number of elements in the returned buffer

alphaToCoverageEnable
```
public boolean alphaToCoverageEnable()
```
Returns the value of the alphaToCoverageEnable field.

alphaToOneEnable
```
public boolean alphaToOneEnable()
```
Returns the value of the alphaToOneEnable field.

sType

public VkPipelineMultisampleStateCreateInfo sType(int value)

Sets the specified value to the sType field.

pNext

public VkPipelineMultisampleStateCreateInfo pNext(long value)

Sets the specified value to the pNext field.

flags

public VkPipelineMultisampleStateCreateInfo flags(int value)

Sets the specified value to the flags field.

rasterizationSamples

public VkPipelineMultisampleStateCreateInfo rasterizationSamples(int value)

Sets the specified value to the rasterizationSamples field.

sampleShadingEnable

public VkPipelineMultisampleStateCreateInfo sampleShadingEnable(boolean value)

Sets the specified value to the sampleShadingEnable field.

minSampleShading

public VkPipelineMultisampleStateCreateInfo minSampleShading(float value)

Sets the specified value to the minSampleShading field.

pSampleMask

public VkPipelineMultisampleStateCreateInfo pSampleMask(@Nullable
                                                        java.nio.IntBuffer value)

Sets the address of the specified IntBuffer to the pSampleMask field.

alphaToCoverageEnable

public VkPipelineMultisampleStateCreateInfo alphaToCoverageEnable(boolean value)

Sets the specified value to the alphaToCoverageEnable field.

alphaToOneEnable

public VkPipelineMultisampleStateCreateInfo alphaToOneEnable(boolean value)

Sets the specified value to the alphaToOneEnable field.

set

public VkPipelineMultisampleStateCreateInfo set(int sType,
                                                long pNext,
                                                int flags,
                                                int rasterizationSamples,
                                                boolean sampleShadingEnable,
                                                float minSampleShading,
                                                @Nullable
                                                java.nio.IntBuffer pSampleMask,
                                                boolean alphaToCoverageEnable,
                                                boolean alphaToOneEnable)

Initializes this struct with the specified values.

set
```
public VkPipelineMultisampleStateCreateInfo set(VkPipelineMultisampleStateCreateInfo src)
```
Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc
```
public static VkPipelineMultisampleStateCreateInfo malloc()
```
Returns a new VkPipelineMultisampleStateCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkPipelineMultisampleStateCreateInfo calloc()
```
Returns a new VkPipelineMultisampleStateCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkPipelineMultisampleStateCreateInfo create()
```
Returns a new VkPipelineMultisampleStateCreateInfo instance allocated with BufferUtils.

create
```
public static VkPipelineMultisampleStateCreateInfo create(long address)
```
Returns a new VkPipelineMultisampleStateCreateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineMultisampleStateCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkPipelineMultisampleStateCreateInfo.Buffer malloc(int capacity)
```
Returns a new VkPipelineMultisampleStateCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkPipelineMultisampleStateCreateInfo.Buffer calloc(int capacity)
```
Returns a new VkPipelineMultisampleStateCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkPipelineMultisampleStateCreateInfo.Buffer create(int capacity)
```
Returns a new VkPipelineMultisampleStateCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPipelineMultisampleStateCreateInfo.Buffer create(long address,
                                                                 int capacity)

Create a VkPipelineMultisampleStateCreateInfo.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

@Nullable
public static VkPipelineMultisampleStateCreateInfo.Buffer createSafe(long address,
                                                                     int capacity)

Like create, but returns null if address is NULL.

mallocStack
```
public static VkPipelineMultisampleStateCreateInfo mallocStack()
```
Returns a new VkPipelineMultisampleStateCreateInfo instance allocated on the thread-local MemoryStack.

callocStack
```
public static VkPipelineMultisampleStateCreateInfo callocStack()
```
Returns a new VkPipelineMultisampleStateCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack
```
public static VkPipelineMultisampleStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineMultisampleStateCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack
```
public static VkPipelineMultisampleStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineMultisampleStateCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

mallocStack
```
public static VkPipelineMultisampleStateCreateInfo.Buffer mallocStack(int capacity)
```
Returns a new VkPipelineMultisampleStateCreateInfo.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack
```
public static VkPipelineMultisampleStateCreateInfo.Buffer callocStack(int capacity)
```
Returns a new VkPipelineMultisampleStateCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

mallocStack

public static VkPipelineMultisampleStateCreateInfo.Buffer mallocStack(int capacity,
                                                                      org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineMultisampleStateCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

callocStack
```
public static VkPipelineMultisampleStateCreateInfo.Buffer callocStack(int capacity,
                                                                      org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineMultisampleStateCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nrasterizationSamples
```
public static int nrasterizationSamples(long struct)
```
Unsafe version of rasterizationSamples().

nsampleShadingEnable
```
public static int nsampleShadingEnable(long struct)
```
Unsafe version of sampleShadingEnable().

nminSampleShading

public static float nminSampleShading(long struct)

Unsafe version of minSampleShading().

npSampleMask

@Nullable
public static java.nio.IntBuffer npSampleMask(long struct,
                                              int capacity)

Unsafe version of pSampleMask.

nalphaToCoverageEnable
```
public static int nalphaToCoverageEnable(long struct)
```
Unsafe version of alphaToCoverageEnable().

nalphaToOneEnable

public static int nalphaToOneEnable(long struct)

Unsafe version of alphaToOneEnable().

nsType

public static void nsType(long struct,
                          int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
                          long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
                          int value)

Unsafe version of flags.

nrasterizationSamples

public static void nrasterizationSamples(long struct,
                                         int value)

Unsafe version of rasterizationSamples.

nsampleShadingEnable

public static void nsampleShadingEnable(long struct,
                                        int value)

Unsafe version of sampleShadingEnable.

nminSampleShading

public static void nminSampleShading(long struct,
                                     float value)

Unsafe version of minSampleShading.

npSampleMask

public static void npSampleMask(long struct,
                                @Nullable
                                java.nio.IntBuffer value)

Unsafe version of pSampleMask.

nalphaToCoverageEnable

public static void nalphaToCoverageEnable(long struct,
                                          int value)

Unsafe version of alphaToCoverageEnable.

nalphaToOneEnable

public static void nalphaToOneEnable(long struct,
                                     int value)

Unsafe version of alphaToOneEnable.

Class VkPipelineMultisampleStateCreateInfo

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, RASTERIZATIONSAMPLES, SAMPLESHADINGENABLE, MINSAMPLESHADING, PSAMPLEMASK, ALPHATOCOVERAGEENABLE, ALPHATOONEENABLE

Constructor Detail

VkPipelineMultisampleStateCreateInfo

Method Detail

sizeof

sType

pNext

flags

rasterizationSamples

sampleShadingEnable

minSampleShading

pSampleMask

alphaToCoverageEnable

alphaToOneEnable

sType

pNext

flags

rasterizationSamples

sampleShadingEnable

minSampleShading

pSampleMask

alphaToCoverageEnable

alphaToOneEnable

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nrasterizationSamples

nsampleShadingEnable

nminSampleShading

npSampleMask

nalphaToCoverageEnable

nalphaToOneEnable

nsType

npNext

nflags

nrasterizationSamples

nsampleShadingEnable

nminSampleShading

npSampleMask

nalphaToCoverageEnable

nalphaToOneEnable