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, NativeResource, Pointer
public class VkPipelineMultisampleStateCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about multisampling as part of graphics pipeline creation.
Valid Usage
sTypemust beSTRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFOpNextmust beNULLflagsmust be 0rasterizationSamplesmust be a validVkSampleCountFlagBitsvalue- If
pSampleMaskis notNULL,pSampleMaskmust be a pointer to an array ofceil(rasterizationSamples / 32)VkSampleMaskvalues - 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]
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFOpNext– reserved for use by extensionsflags– reserved for future userasterizationSamples– aVkSampleCountFlagBitsspecifying the number of samples per pixel used in rasterization. One of:SAMPLE_COUNT_16_BITSAMPLE_COUNT_1_BITSAMPLE_COUNT_2_BITSAMPLE_COUNT_32_BITSAMPLE_COUNT_4_BITSAMPLE_COUNT_64_BITSAMPLE_COUNT_8_BITsampleShadingEnable– specifies that fragment shading executes per-sample ifTRUE, or per-fragment ifFALSEminSampleShading– the minimum fraction of sample shadingpSampleMask– a bitmask of static coverage information that is ANDed with the coverage information generated during rasterizationalphaToCoverageEnable– controls whether a temporary coverage value is generated based on the alpha component of the fragment’s first color outputalphaToOneEnable– controls whether the alpha component of the fragment’s first color output is replaced with one
Layout
struct VkPipelineMultisampleStateCreateInfo { VkStructureType sType; const void * pNext; VkPipelineMultisampleStateCreateFlags flags; VkSampleCountFlagBits rasterizationSamples; VkBool32 sampleShadingEnable; float minSampleShading; const VkSampleMask * pSampleMask; VkBool32 alphaToCoverageEnable; VkBool32 alphaToOneEnable; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkPipelineMultisampleStateCreateInfo.BufferAn array ofVkPipelineMultisampleStateCreateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and 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 Modifier and Type Method and Description intalphaToCoverageEnable()Returns the value of thealphaToCoverageEnablefield.VkPipelineMultisampleStateCreateInfoalphaToCoverageEnable(int value)Sets the specified value to thealphaToCoverageEnablefield.intalphaToOneEnable()Returns the value of thealphaToOneEnablefield.VkPipelineMultisampleStateCreateInfoalphaToOneEnable(int value)Sets the specified value to thealphaToOneEnablefield.static VkPipelineMultisampleStateCreateInfocalloc()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemCalloc.static VkPipelineMultisampleStateCreateInfo.Buffercalloc(int capacity)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemCalloc.static VkPipelineMultisampleStateCreateInfocallocStack()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfo.BuffercallocStack(int capacity)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfocallocStack(MemoryStack stack)Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.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 ornullif the address isNULL.static VkPipelineMultisampleStateCreateInfo.Buffercreate(long address, int capacity)Create aVkPipelineMultisampleStateCreateInfo.Bufferinstance at the specified memory.intflags()Returns the value of theflagsfield.VkPipelineMultisampleStateCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkPipelineMultisampleStateCreateInfomalloc()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated withmemAlloc.static VkPipelineMultisampleStateCreateInfo.Buffermalloc(int capacity)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated withmemAlloc.static VkPipelineMultisampleStateCreateInfomallocStack()Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the thread-localMemoryStack.static VkPipelineMultisampleStateCreateInfo.BuffermallocStack(int capacity)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkPipelineMultisampleStateCreateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineMultisampleStateCreateInfomallocStack(MemoryStack stack)Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStack.floatminSampleShading()Returns the value of theminSampleShadingfield.VkPipelineMultisampleStateCreateInfominSampleShading(float value)Sets the specified value to theminSampleShadingfield.VkPipelineMultisampleStateCreateInfonset(long struct)Unsafe version ofset.longpNext()Returns the value of thepNextfield.VkPipelineMultisampleStateCreateInfopNext(long value)Sets the specified value to thepNextfield.java.nio.IntBufferpSampleMask(int capacity)Returns aIntBufferview of the data pointed to by thepSampleMaskfield.VkPipelineMultisampleStateCreateInfopSampleMask(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepSampleMaskfield.intrasterizationSamples()Returns the value of therasterizationSamplesfield.VkPipelineMultisampleStateCreateInforasterizationSamples(int value)Sets the specified value to therasterizationSamplesfield.intsampleShadingEnable()Returns the value of thesampleShadingEnablefield.VkPipelineMultisampleStateCreateInfosampleShadingEnable(int value)Sets the specified value to thesampleShadingEnablefield.VkPipelineMultisampleStateCreateInfoset(int sType, long pNext, int flags, int rasterizationSamples, int sampleShadingEnable, float minSampleShading, java.nio.IntBuffer pSampleMask, int alphaToCoverageEnable, int alphaToOneEnable)Initializes this struct with the specified values.VkPipelineMultisampleStateCreateInfoset(VkPipelineMultisampleStateCreateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkPipelineMultisampleStateCreateInfosType(int value)Sets the specified value to thesTypefield.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
rasterizationSamples
public int rasterizationSamples()
Returns the value of therasterizationSamplesfield.
-
sampleShadingEnable
public int sampleShadingEnable()
Returns the value of thesampleShadingEnablefield.
-
minSampleShading
public float minSampleShading()
Returns the value of theminSampleShadingfield.
-
pSampleMask
public java.nio.IntBuffer pSampleMask(int capacity)
Returns aIntBufferview of the data pointed to by thepSampleMaskfield.- Parameters:
capacity- the number of elements in the returned buffer
-
alphaToCoverageEnable
public int alphaToCoverageEnable()
Returns the value of thealphaToCoverageEnablefield.
-
alphaToOneEnable
public int alphaToOneEnable()
Returns the value of thealphaToOneEnablefield.
-
sType
public VkPipelineMultisampleStateCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkPipelineMultisampleStateCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkPipelineMultisampleStateCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
rasterizationSamples
public VkPipelineMultisampleStateCreateInfo rasterizationSamples(int value)
Sets the specified value to therasterizationSamplesfield.
-
sampleShadingEnable
public VkPipelineMultisampleStateCreateInfo sampleShadingEnable(int value)
Sets the specified value to thesampleShadingEnablefield.
-
minSampleShading
public VkPipelineMultisampleStateCreateInfo minSampleShading(float value)
Sets the specified value to theminSampleShadingfield.
-
pSampleMask
public VkPipelineMultisampleStateCreateInfo pSampleMask(java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepSampleMaskfield.
-
alphaToCoverageEnable
public VkPipelineMultisampleStateCreateInfo alphaToCoverageEnable(int value)
Sets the specified value to thealphaToCoverageEnablefield.
-
alphaToOneEnable
public VkPipelineMultisampleStateCreateInfo alphaToOneEnable(int value)
Sets the specified value to thealphaToOneEnablefield.
-
set
public VkPipelineMultisampleStateCreateInfo set(int sType, long pNext, int flags, int rasterizationSamples, int sampleShadingEnable, float minSampleShading, java.nio.IntBuffer pSampleMask, int alphaToCoverageEnable, int alphaToOneEnable)
Initializes this struct with the specified values.
-
nset
public VkPipelineMultisampleStateCreateInfo nset(long struct)
Unsafe version ofset.
-
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 ornullif the address isNULL.
-
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
-
mallocStack
public static VkPipelineMultisampleStateCreateInfo mallocStack()
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPipelineMultisampleStateCreateInfo callocStack()
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPipelineMultisampleStateCreateInfo mallocStack(MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPipelineMultisampleStateCreateInfo callocStack(MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkPipelineMultisampleStateCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPipelineMultisampleStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPipelineMultisampleStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkPipelineMultisampleStateCreateInfo.Buffer callocStack(int capacity, 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
-
-