Package org.lwjgl.vulkan
Class VkPipelineMultisampleStateCreateInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPipelineMultisampleStateCreateInfo>
org.lwjgl.vulkan.VkPipelineMultisampleStateCreateInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineMultisampleStateCreateInfo
extends org.lwjgl.system.Struct<VkPipelineMultisampleStateCreateInfo>
implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created pipeline multisample state.
Description
Each bit in the sample mask is associated with a unique sample index as defined for the coverage mask. Each bit b for mask word w in the sample mask corresponds to sample index i, where i = 32 × w + b. pSampleMask has a length equal to ⌈ rasterizationSamples / 32 ⌉ words.
If pSampleMask is NULL, it is treated as if the mask has all bits set to 1.
Valid Usage
- If the
sampleRateShadingfeature is not enabled,sampleShadingEnablemust beFALSE - If the
alphaToOnefeature is not enabled,alphaToOneEnablemust beFALSE minSampleShadingmust be in the range[0,1]- If the
VK_NV_framebuffer_mixed_samplesextension is enabled, and if the subpass has any color attachments andrasterizationSamplesis greater than the number of color samples, thensampleShadingEnablemust beFALSE
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkPipelineCoverageModulationStateCreateInfoNV,VkPipelineCoverageReductionStateCreateInfoNV,VkPipelineCoverageToColorStateCreateInfoNV, orVkPipelineSampleLocationsStateCreateInfoEXT - The
sTypevalue of each struct in thepNextchain must be unique flagsmust be 0rasterizationSamplesmust be a validVkSampleCountFlagBitsvalue- If
pSampleMaskis notNULL,pSampleMaskmust be a valid pointer to an array ofceil(rasterizationSamples / 32)VkSampleMaskvalues
See Also
Layout
struct VkPipelineMultisampleStateCreateInfo {
VkStructureType sType();
void const * pNext();
VkPipelineMultisampleStateCreateFlags flags();
VkSampleCountFlagBits rasterizationSamples();
VkBool32 sampleShadingEnable();
float minSampleShading();
VkSampleMask const * pSampleMask(int);
VkBool32 alphaToCoverageEnable();
VkBool32 alphaToOneEnable();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPipelineMultisampleStateCreateInfostructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkPipelineMultisampleStateCreateInfo(ByteBuffer container) Creates aVkPipelineMultisampleStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionbooleancontrols 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.alphaToCoverageEnable(boolean value) Sets the specified value to thealphaToCoverageEnable()field.booleancontrols whether the alpha component of the fragment’s first color output is replaced with one as described in Multisample Coverage.alphaToOneEnable(boolean value) Sets the specified value to thealphaToOneEnable()field.calloc()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineMultisampleStateCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineMultisampleStateCreateInfo.Bufferinstance at the specified memory.static @Nullable VkPipelineMultisampleStateCreateInfocreateSafe(long address) static @Nullable VkPipelineMultisampleStateCreateInfo.BuffercreateSafe(long address, int capacity) intflags()reserved for future use.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.floatspecifies a minimum fraction of sample shading ifsampleShadingEnableisTRUE.minSampleShading(float value) Sets the specified value to theminSampleShading()field.static intnalphaToCoverageEnable(long struct) Unsafe version ofalphaToCoverageEnable().static voidnalphaToCoverageEnable(long struct, int value) Unsafe version ofalphaToCoverageEnable.static intnalphaToOneEnable(long struct) Unsafe version ofalphaToOneEnable().static voidnalphaToOneEnable(long struct, int value) Unsafe version ofalphaToOneEnable.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static floatnminSampleShading(long struct) Unsafe version ofminSampleShading().static voidnminSampleShading(long struct, float value) Unsafe version ofminSampleShading.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable IntBuffernpSampleMask(long struct, int capacity) Unsafe version ofpSampleMask.static voidnpSampleMask(long struct, @Nullable IntBuffer value) Unsafe version ofpSampleMask.static intnrasterizationSamples(long struct) Unsafe version ofrasterizationSamples().static voidnrasterizationSamples(long struct, int value) Unsafe version ofrasterizationSamples.static intnsampleShadingEnable(long struct) Unsafe version ofsampleShadingEnable().static voidnsampleShadingEnable(long struct, int value) Unsafe version ofsampleShadingEnable.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkPipelineCoverageModulationStateCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkPipelineCoverageReductionStateCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkPipelineCoverageToColorStateCreateInfoNVvalue to thepNextchain.Prepends the specifiedVkPipelineSampleLocationsStateCreateInfoEXTvalue to thepNextchain.@Nullable IntBufferpSampleMask(int capacity) pSampleMask(@Nullable IntBuffer value) Sets the address of the specifiedIntBufferto thepSampleMask(int)field.intaVkSampleCountFlagBitsvalue specifying the number of samples used in rasterization.rasterizationSamples(int value) Sets the specified value to therasterizationSamples()field.booleancan be used to enable Sample Shading.sampleShadingEnable(boolean value) Sets the specified value to thesampleShadingEnable()field.set(int sType, long pNext, int flags, int rasterizationSamples, boolean sampleShadingEnable, float minSampleShading, @Nullable IntBuffer pSampleMask, boolean alphaToCoverageEnable, boolean alphaToOneEnable) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFOvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
RASTERIZATIONSAMPLES
public static final int RASTERIZATIONSAMPLESThe struct member offsets. -
SAMPLESHADINGENABLE
public static final int SAMPLESHADINGENABLEThe struct member offsets. -
MINSAMPLESHADING
public static final int MINSAMPLESHADINGThe struct member offsets. -
PSAMPLEMASK
public static final int PSAMPLEMASKThe struct member offsets. -
ALPHATOCOVERAGEENABLE
public static final int ALPHATOCOVERAGEENABLEThe struct member offsets. -
ALPHATOONEENABLE
public static final int ALPHATOONEENABLEThe struct member offsets.
-
-
Constructor Details
-
VkPipelineMultisampleStateCreateInfo
Creates aVkPipelineMultisampleStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkPipelineMultisampleStateCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()reserved for future use. -
rasterizationSamples
public int rasterizationSamples()aVkSampleCountFlagBitsvalue specifying the number of samples used in rasterization. This value is ignored for the purposes of setting the number of samples used in rasterization if the pipeline is created with theDYNAMIC_STATE_RASTERIZATION_SAMPLES_EXTdynamic state set, but ifDYNAMIC_STATE_SAMPLE_MASK_EXTdynamic state is not set, it is still used to define the size of thepSampleMaskarray as described below. -
sampleShadingEnable
public boolean sampleShadingEnable()can be used to enable Sample Shading. -
minSampleShading
public float minSampleShading()specifies a minimum fraction of sample shading ifsampleShadingEnableisTRUE. -
pSampleMask
- Parameters:
capacity- the number of elements in the returned buffer- Returns:
- a pointer to an array of
VkSampleMaskvalues used in the sample mask test.
-
alphaToCoverageEnable
public boolean 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
public boolean alphaToOneEnable()controls whether the alpha component of the fragment’s first color output is replaced with one as described in Multisample Coverage. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
public VkPipelineMultisampleStateCreateInfo pNext(VkPipelineCoverageModulationStateCreateInfoNV value) Prepends the specifiedVkPipelineCoverageModulationStateCreateInfoNVvalue to thepNextchain. -
pNext
public VkPipelineMultisampleStateCreateInfo pNext(VkPipelineCoverageReductionStateCreateInfoNV value) Prepends the specifiedVkPipelineCoverageReductionStateCreateInfoNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkPipelineCoverageToColorStateCreateInfoNVvalue to thepNextchain. -
pNext
public VkPipelineMultisampleStateCreateInfo pNext(VkPipelineSampleLocationsStateCreateInfoEXT value) Prepends the specifiedVkPipelineSampleLocationsStateCreateInfoEXTvalue to thepNextchain. -
flags
Sets the specified value to theflags()field. -
rasterizationSamples
Sets the specified value to therasterizationSamples()field. -
sampleShadingEnable
Sets the specified value to thesampleShadingEnable()field. -
minSampleShading
Sets the specified value to theminSampleShading()field. -
pSampleMask
Sets the address of the specifiedIntBufferto thepSampleMask(int)field. -
alphaToCoverageEnable
Sets the specified value to thealphaToCoverageEnable()field. -
alphaToOneEnable
Sets the specified value to thealphaToOneEnable()field. -
set
public VkPipelineMultisampleStateCreateInfo set(int sType, long pNext, int flags, int rasterizationSamples, boolean sampleShadingEnable, float minSampleShading, @Nullable IntBuffer pSampleMask, boolean alphaToCoverageEnable, boolean alphaToOneEnable) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkPipelineMultisampleStateCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineMultisampleStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPipelineMultisampleStateCreateInfo.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineMultisampleStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineMultisampleStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineMultisampleStateCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineMultisampleStateCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineMultisampleStateCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineMultisampleStateCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
nrasterizationSamples
public static int nrasterizationSamples(long struct) Unsafe version ofrasterizationSamples(). -
nsampleShadingEnable
public static int nsampleShadingEnable(long struct) Unsafe version ofsampleShadingEnable(). -
nminSampleShading
public static float nminSampleShading(long struct) Unsafe version ofminSampleShading(). -
npSampleMask
Unsafe version ofpSampleMask. -
nalphaToCoverageEnable
public static int nalphaToCoverageEnable(long struct) Unsafe version ofalphaToCoverageEnable(). -
nalphaToOneEnable
public static int nalphaToOneEnable(long struct) Unsafe version ofalphaToOneEnable(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
nrasterizationSamples
public static void nrasterizationSamples(long struct, int value) Unsafe version ofrasterizationSamples. -
nsampleShadingEnable
public static void nsampleShadingEnable(long struct, int value) Unsafe version ofsampleShadingEnable. -
nminSampleShading
public static void nminSampleShading(long struct, float value) Unsafe version ofminSampleShading. -
npSampleMask
Unsafe version ofpSampleMask. -
nalphaToCoverageEnable
public static void nalphaToCoverageEnable(long struct, int value) Unsafe version ofalphaToCoverageEnable. -
nalphaToOneEnable
public static void nalphaToOneEnable(long struct, int value) Unsafe version ofalphaToOneEnable.
-