Package org.lwjgl.vulkan
Class VkPipelineMultisampleStateCreateInfo
- 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.NativeResourceStructure 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
bfor mask wordwin the sample mask corresponds to sample indexi, wherei = 32 × w + b.pSampleMaskhas a length equal to⌈ rasterizationSamples / 32 ⌉words.If
pSampleMaskisNULL, it is treated as if the mask has all bits set to 1.Valid Usage
- If the sample rate shading feature is not enabled,
sampleShadingEnablemust beFALSE - If the alpha to one feature 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 { VkStructureTypesType(); void const *pNext(); VkPipelineMultisampleStateCreateFlagsflags(); VkSampleCountFlagBitsrasterizationSamples(); VkBool32sampleShadingEnable(); floatminSampleShading(); VkSampleMask const *pSampleMask(int); VkBool32alphaToCoverageEnable(); VkBool32alphaToOneEnable(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPipelineMultisampleStateCreateInfo.BufferAn array ofVkPipelineMultisampleStateCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intALPHATOCOVERAGEENABLE
ALPHATOONEENABLE
FLAGS
MINSAMPLESHADING
PNEXT
PSAMPLEMASK
RASTERIZATIONSAMPLES
SAMPLESHADINGENABLEThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineMultisampleStateCreateInfo(java.nio.ByteBuffer container)Creates aVkPipelineMultisampleStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleanalphaToCoverageEnable()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.VkPipelineMultisampleStateCreateInfoalphaToCoverageEnable(boolean value)Sets the specified value to thealphaToCoverageEnable()field.booleanalphaToOneEnable()controls whether the alpha component of the fragment’s first color output is replaced with one as described in Multisample Coverage.VkPipelineMultisampleStateCreateInfoalphaToOneEnable(boolean value)Sets the specified value to thealphaToOneEnable()field.static VkPipelineMultisampleStateCreateInfocalloc()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemCalloc.static VkPipelineMultisampleStateCreateInfo.Buffercalloc(int capacity)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemCalloc.static VkPipelineMultisampleStateCreateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfocallocStack()Deprecated.static VkPipelineMultisampleStateCreateInfo.BuffercallocStack(int capacity)Deprecated.static VkPipelineMultisampleStateCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineMultisampleStateCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineMultisampleStateCreateInfocreate()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withBufferUtils.static VkPipelineMultisampleStateCreateInfo.Buffercreate(int capacity)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withBufferUtils.static VkPipelineMultisampleStateCreateInfocreate(long address)Returns a newVkPipelineMultisampleStateCreateInfoinstance for the specified memory address.static VkPipelineMultisampleStateCreateInfo.Buffercreate(long address, int capacity)Create aVkPipelineMultisampleStateCreateInfo.Bufferinstance at the specified memory.static VkPipelineMultisampleStateCreateInfocreateSafe(long address)static VkPipelineMultisampleStateCreateInfo.BuffercreateSafe(long address, int capacity)intflags()reserved for future use.VkPipelineMultisampleStateCreateInfoflags(int value)Sets the specified value to theflags()field.static VkPipelineMultisampleStateCreateInfomalloc()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemAlloc.static VkPipelineMultisampleStateCreateInfo.Buffermalloc(int capacity)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemAlloc.static VkPipelineMultisampleStateCreateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineMultisampleStateCreateInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStack.static VkPipelineMultisampleStateCreateInfomallocStack()Deprecated.static VkPipelineMultisampleStateCreateInfo.BuffermallocStack(int capacity)Deprecated.static VkPipelineMultisampleStateCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineMultisampleStateCreateInfomallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.floatminSampleShading()specifies a minimum fraction of sample shading ifsampleShadingEnableis set toTRUE.VkPipelineMultisampleStateCreateInfominSampleShading(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 java.nio.IntBuffernpSampleMask(long struct, int capacity)Unsafe version ofpSampleMask.static voidnpSampleMask(long struct, java.nio.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.VkPipelineMultisampleStateCreateInfopNext(long value)Sets the specified value to thepNext()field.VkPipelineMultisampleStateCreateInfopNext(VkPipelineCoverageModulationStateCreateInfoNV value)Prepends the specifiedVkPipelineCoverageModulationStateCreateInfoNVvalue to thepNextchain.VkPipelineMultisampleStateCreateInfopNext(VkPipelineCoverageReductionStateCreateInfoNV value)Prepends the specifiedVkPipelineCoverageReductionStateCreateInfoNVvalue to thepNextchain.VkPipelineMultisampleStateCreateInfopNext(VkPipelineCoverageToColorStateCreateInfoNV value)Prepends the specifiedVkPipelineCoverageToColorStateCreateInfoNVvalue to thepNextchain.VkPipelineMultisampleStateCreateInfopNext(VkPipelineSampleLocationsStateCreateInfoEXT value)Prepends the specifiedVkPipelineSampleLocationsStateCreateInfoEXTvalue to thepNextchain.java.nio.IntBufferpSampleMask(int capacity)VkPipelineMultisampleStateCreateInfopSampleMask(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepSampleMask(int)field.intrasterizationSamples()aVkSampleCountFlagBitsvalue specifying the number of samples used in rasterization.VkPipelineMultisampleStateCreateInforasterizationSamples(int value)Sets the specified value to therasterizationSamples()field.booleansampleShadingEnable()can be used to enable Sample Shading.VkPipelineMultisampleStateCreateInfosampleShadingEnable(boolean value)Sets the specified value to thesampleShadingEnable()field.VkPipelineMultisampleStateCreateInfoset(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.VkPipelineMultisampleStateCreateInfoset(VkPipelineMultisampleStateCreateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkPipelineMultisampleStateCreateInfosType(int value)Sets the specified value to thesType()field.VkPipelineMultisampleStateCreateInfosType$Default()Sets theSTRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFOvalue to thesType()field.
-
-
-
Constructor Detail
-
VkPipelineMultisampleStateCreateInfo
public VkPipelineMultisampleStateCreateInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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.
-
sampleShadingEnable
public boolean sampleShadingEnable()
can be used to enable Sample Shading.
-
minSampleShading
public float minSampleShading()
specifies a minimum fraction of sample shading ifsampleShadingEnableis set toTRUE.
-
pSampleMask
@Nullable public java.nio.IntBuffer pSampleMask(int capacity)
- 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
public VkPipelineMultisampleStateCreateInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkPipelineMultisampleStateCreateInfo sType$Default()
Sets theSTRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFOvalue to thesType()field.
-
pNext
public VkPipelineMultisampleStateCreateInfo pNext(long value)
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
public VkPipelineMultisampleStateCreateInfo pNext(VkPipelineCoverageToColorStateCreateInfoNV value)
Prepends the specifiedVkPipelineCoverageToColorStateCreateInfoNVvalue to thepNextchain.
-
pNext
public VkPipelineMultisampleStateCreateInfo pNext(VkPipelineSampleLocationsStateCreateInfoEXT value)
Prepends the specifiedVkPipelineSampleLocationsStateCreateInfoEXTvalue to thepNextchain.
-
flags
public VkPipelineMultisampleStateCreateInfo flags(int value)
Sets the specified value to theflags()field.
-
rasterizationSamples
public VkPipelineMultisampleStateCreateInfo rasterizationSamples(int value)
Sets the specified value to therasterizationSamples()field.
-
sampleShadingEnable
public VkPipelineMultisampleStateCreateInfo sampleShadingEnable(boolean value)
Sets the specified value to thesampleShadingEnable()field.
-
minSampleShading
public VkPipelineMultisampleStateCreateInfo minSampleShading(float value)
Sets the specified value to theminSampleShading()field.
-
pSampleMask
public VkPipelineMultisampleStateCreateInfo pSampleMask(@Nullable java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepSampleMask(int)field.
-
alphaToCoverageEnable
public VkPipelineMultisampleStateCreateInfo alphaToCoverageEnable(boolean value)
Sets the specified value to thealphaToCoverageEnable()field.
-
alphaToOneEnable
public VkPipelineMultisampleStateCreateInfo alphaToOneEnable(boolean value)
Sets the specified value to thealphaToOneEnable()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 newVkPipelineMultisampleStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineMultisampleStateCreateInfo calloc()
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineMultisampleStateCreateInfo create()
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withBufferUtils.
-
create
public static VkPipelineMultisampleStateCreateInfo create(long address)
Returns a newVkPipelineMultisampleStateCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineMultisampleStateCreateInfo createSafe(long address)
-
malloc
public static VkPipelineMultisampleStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineMultisampleStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineMultisampleStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineMultisampleStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineMultisampleStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPipelineMultisampleStateCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkPipelineMultisampleStateCreateInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineMultisampleStateCreateInfo 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 public static VkPipelineMultisampleStateCreateInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineMultisampleStateCreateInfo.Buffer callocStack(int capacity)
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
public static VkPipelineMultisampleStateCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPipelineMultisampleStateCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
@Nullable public static java.nio.IntBuffer npSampleMask(long struct, int capacity)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
public static void npSampleMask(long struct, @Nullable java.nio.IntBuffer value)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.
-
-