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.NativeResource
Structure specifying parameters of a newly created pipeline multisample state.Valid Usage
- 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]
- If the
VK_NV_framebuffer_mixed_samples
extension is enabled, and if the subpass has any color attachments andrasterizationSamples
is greater than the number of color samples, thensampleShadingEnable
must beFALSE
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofVkPipelineCoverageModulationStateCreateInfoNV
,VkPipelineCoverageReductionStateCreateInfoNV
,VkPipelineCoverageToColorStateCreateInfoNV
, orVkPipelineSampleLocationsStateCreateInfoEXT
- Each
sType
member in thepNext
chain must be unique flags
must be 0rasterizationSamples
must be a validVkSampleCountFlagBits
value- If
pSampleMask
is notNULL
,pSampleMask
must be a valid pointer to an array ofceil(rasterizationSamples / 32)
VkSampleMask
values
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.flags
– reserved for future use.rasterizationSamples
– aVkSampleCountFlagBits
specifying the number of samples used in rasterization.sampleShadingEnable
– can be used to enable Sample Shading.minSampleShading
– specifies a minimum fraction of sample shading ifsampleShadingEnable
is set toTRUE
.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 ofVkPipelineMultisampleStateCreateInfo
structs.
-
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
SAMPLESHADINGENABLEThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor 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 Description boolean
alphaToCoverageEnable()
Returns the value of thealphaToCoverageEnable
field.VkPipelineMultisampleStateCreateInfo
alphaToCoverageEnable(boolean value)
Sets the specified value to thealphaToCoverageEnable
field.boolean
alphaToOneEnable()
Returns the value of thealphaToOneEnable
field.VkPipelineMultisampleStateCreateInfo
alphaToOneEnable(boolean 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, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineMultisampleStateCreateInfo
callocStack(org.lwjgl.system.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.static VkPipelineMultisampleStateCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineMultisampleStateCreateInfo.Buffer
instance at the specified memory.static VkPipelineMultisampleStateCreateInfo
createSafe(long address)
static VkPipelineMultisampleStateCreateInfo.Buffer
createSafe(long address, int capacity)
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, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineMultisampleStateCreateInfo
mallocStack(org.lwjgl.system.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.static int
nalphaToCoverageEnable(long struct)
Unsafe version ofalphaToCoverageEnable()
.static void
nalphaToCoverageEnable(long struct, int value)
Unsafe version ofalphaToCoverageEnable
.static int
nalphaToOneEnable(long struct)
Unsafe version ofalphaToOneEnable()
.static void
nalphaToOneEnable(long struct, int value)
Unsafe version ofalphaToOneEnable
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static float
nminSampleShading(long struct)
Unsafe version ofminSampleShading()
.static void
nminSampleShading(long struct, float value)
Unsafe version ofminSampleShading
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static java.nio.IntBuffer
npSampleMask(long struct, int capacity)
Unsafe version ofpSampleMask
.static void
npSampleMask(long struct, java.nio.IntBuffer value)
Unsafe version ofpSampleMask
.static int
nrasterizationSamples(long struct)
Unsafe version ofrasterizationSamples()
.static void
nrasterizationSamples(long struct, int value)
Unsafe version ofrasterizationSamples
.static int
nsampleShadingEnable(long struct)
Unsafe version ofsampleShadingEnable()
.static void
nsampleShadingEnable(long struct, int value)
Unsafe version ofsampleShadingEnable
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.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.boolean
sampleShadingEnable()
Returns the value of thesampleShadingEnable
field.VkPipelineMultisampleStateCreateInfo
sampleShadingEnable(boolean value)
Sets the specified value to thesampleShadingEnable
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 thesType
field.VkPipelineMultisampleStateCreateInfo
sType(int value)
Sets the specified value to thesType
field.
-
-
-
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()
- Specified by:
sizeof
in classorg.lwjgl.system.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 boolean sampleShadingEnable()
Returns the value of thesampleShadingEnable
field.
-
minSampleShading
public float minSampleShading()
Returns the value of theminSampleShading
field.
-
pSampleMask
@Nullable 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 boolean alphaToCoverageEnable()
Returns the value of thealphaToCoverageEnable
field.
-
alphaToOneEnable
public boolean 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(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 specifiedIntBuffer
to thepSampleMask
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 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.
-
createSafe
@Nullable public static VkPipelineMultisampleStateCreateInfo createSafe(long address)
-
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
-
createSafe
@Nullable public static VkPipelineMultisampleStateCreateInfo.Buffer createSafe(long address, int 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(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineMultisampleStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineMultisampleStateCreateInfo callocStack(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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
-
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
.
-
-