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
sType
must beSTRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
pNext
must beNULL
flags
must be 0rasterizationSamples
must be a validVkSampleCountFlagBits
value- If
pSampleMask
is notNULL
,pSampleMask
must be a pointer to an array ofceil(rasterizationSamples / 32)
VkSampleMask
values - If the sample rate shading feature is not enabled,
sampleShadingEnable
must beFALSE
- If the alpha to one feature is not enabled,
alphaToOneEnable
must beFALSE
minSampleShading
must be in the range[0,1]
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
pNext
– reserved for use by extensionsflags
– reserved for future userasterizationSamples
– aVkSampleCountFlagBits
specifying the number of samples per pixel used in rasterization. One of:SAMPLE_COUNT_16_BIT
SAMPLE_COUNT_1_BIT
SAMPLE_COUNT_2_BIT
SAMPLE_COUNT_32_BIT
SAMPLE_COUNT_4_BIT
SAMPLE_COUNT_64_BIT
SAMPLE_COUNT_8_BIT
sampleShadingEnable
– specifies that fragment shading executes per-sample ifTRUE
, or per-fragment ifFALSE
minSampleShading
– 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 class
VkPipelineMultisampleStateCreateInfo.Buffer
An array ofVkPipelineMultisampleStateCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The 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 aVkPipelineMultisampleStateCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description int
alphaToCoverageEnable()
Returns the value of thealphaToCoverageEnable
field.VkPipelineMultisampleStateCreateInfo
alphaToCoverageEnable(int value)
Sets the specified value to thealphaToCoverageEnable
field.int
alphaToOneEnable()
Returns the value of thealphaToOneEnable
field.VkPipelineMultisampleStateCreateInfo
alphaToOneEnable(int value)
Sets the specified value to thealphaToOneEnable
field.static VkPipelineMultisampleStateCreateInfo
calloc()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated withmemCalloc
.static VkPipelineMultisampleStateCreateInfo.Buffer
calloc(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated withmemCalloc
.static VkPipelineMultisampleStateCreateInfo
callocStack()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfo
callocStack(MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfo
create()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated withBufferUtils
.static VkPipelineMultisampleStateCreateInfo.Buffer
create(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated withBufferUtils
.static VkPipelineMultisampleStateCreateInfo
create(long address)
Returns a newVkPipelineMultisampleStateCreateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkPipelineMultisampleStateCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineMultisampleStateCreateInfo.Buffer
instance at the specified memory.int
flags()
Returns the value of theflags
field.VkPipelineMultisampleStateCreateInfo
flags(int value)
Sets the specified value to theflags
field.static VkPipelineMultisampleStateCreateInfo
malloc()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated withmemAlloc
.static VkPipelineMultisampleStateCreateInfo.Buffer
malloc(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated withmemAlloc
.static VkPipelineMultisampleStateCreateInfo
mallocStack()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the thread-localMemoryStack
.static VkPipelineMultisampleStateCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineMultisampleStateCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineMultisampleStateCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the specifiedMemoryStack
.float
minSampleShading()
Returns the value of theminSampleShading
field.VkPipelineMultisampleStateCreateInfo
minSampleShading(float value)
Sets the specified value to theminSampleShading
field.VkPipelineMultisampleStateCreateInfo
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkPipelineMultisampleStateCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.java.nio.IntBuffer
pSampleMask(int capacity)
Returns aIntBuffer
view of the data pointed to by thepSampleMask
field.VkPipelineMultisampleStateCreateInfo
pSampleMask(java.nio.IntBuffer value)
Sets the address of the specifiedIntBuffer
to thepSampleMask
field.int
rasterizationSamples()
Returns the value of therasterizationSamples
field.VkPipelineMultisampleStateCreateInfo
rasterizationSamples(int value)
Sets the specified value to therasterizationSamples
field.int
sampleShadingEnable()
Returns the value of thesampleShadingEnable
field.VkPipelineMultisampleStateCreateInfo
sampleShadingEnable(int value)
Sets the specified value to thesampleShadingEnable
field.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.VkPipelineMultisampleStateCreateInfo
set(VkPipelineMultisampleStateCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkPipelineMultisampleStateCreateInfo
sType(int value)
Sets the specified value to thesType
field.-
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 aVkPipelineMultisampleStateCreateInfo
instance at the current position of the specifiedByteBuffer
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()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
rasterizationSamples
public int rasterizationSamples()
Returns the value of therasterizationSamples
field.
-
sampleShadingEnable
public int sampleShadingEnable()
Returns the value of thesampleShadingEnable
field.
-
minSampleShading
public float minSampleShading()
Returns the value of theminSampleShading
field.
-
pSampleMask
public java.nio.IntBuffer pSampleMask(int capacity)
Returns aIntBuffer
view of the data pointed to by thepSampleMask
field.- Parameters:
capacity
- the number of elements in the returned buffer
-
alphaToCoverageEnable
public int alphaToCoverageEnable()
Returns the value of thealphaToCoverageEnable
field.
-
alphaToOneEnable
public int alphaToOneEnable()
Returns the value of thealphaToOneEnable
field.
-
sType
public VkPipelineMultisampleStateCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineMultisampleStateCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
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(int 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(java.nio.IntBuffer value)
Sets the address of the specifiedIntBuffer
to thepSampleMask
field.
-
alphaToCoverageEnable
public VkPipelineMultisampleStateCreateInfo alphaToCoverageEnable(int value)
Sets the specified value to thealphaToCoverageEnable
field.
-
alphaToOneEnable
public VkPipelineMultisampleStateCreateInfo alphaToOneEnable(int value)
Sets the specified value to thealphaToOneEnable
field.
-
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 newVkPipelineMultisampleStateCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineMultisampleStateCreateInfo calloc()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineMultisampleStateCreateInfo create()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkPipelineMultisampleStateCreateInfo create(long address)
Returns a newVkPipelineMultisampleStateCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkPipelineMultisampleStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineMultisampleStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineMultisampleStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineMultisampleStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineMultisampleStateCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkPipelineMultisampleStateCreateInfo mallocStack()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineMultisampleStateCreateInfo callocStack()
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineMultisampleStateCreateInfo mallocStack(MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineMultisampleStateCreateInfo callocStack(MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the specifiedMemoryStack
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 newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineMultisampleStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineMultisampleStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-