LWJGL 3.3.3 · org.lwjgl.vulkan.VkPipelineMultisampleStateCreateInfo

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 sampleRateShading feature is not enabled, sampleShadingEnable must be FALSE
If the alphaToOne feature is not enabled, alphaToOneEnable must be FALSE
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 and rasterizationSamples is greater than the number of color samples, then sampleShadingEnable must be FALSE

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkPipelineCoverageModulationStateCreateInfoNV, VkPipelineCoverageReductionStateCreateInfoNV, VkPipelineCoverageToColorStateCreateInfoNV, or VkPipelineSampleLocationsStateCreateInfoEXT
The sType value of each struct in the pNext chain must be unique
flags must be 0
rasterizationSamples must be a valid VkSampleCountFlagBits value
If pSampleMask is not NULL, pSampleMask must be a valid pointer to an array of ceil(rasterizationSamples / 32) VkSampleMask values

Layout


struct VkPipelineMultisampleStateCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkPipelineMultisampleStateCreateFlags flags;
    VkSampleCountFlagBits rasterizationSamples;
    VkBool32 sampleShadingEnable;
    float minSampleShading;
    VkSampleMask const * pSampleMask;
    VkBool32 alphaToCoverageEnable;
    VkBool32 alphaToOneEnable;
}

Modifier and Type	Class and Description
public static class	VkPipelineMultisampleStateCreateInfo.Buffer An array of `VkPipelineMultisampleStateCreateInfo` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ALPHATOCOVERAGEENABLE The struct member offsets.
public static final int	ALPHATOONEENABLE The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	MINSAMPLESHADING The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	PSAMPLEMASK The struct member offsets.
public static final int	RASTERIZATIONSAMPLES The struct member offsets.
public static final int	SAMPLESHADINGENABLE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.

Access	Constructor and Description
protected	VkPipelineMultisampleStateCreateInfo(long address, ByteBuffer container)
public	VkPipelineMultisampleStateCreateInfo(ByteBuffer container) Creates a `VkPipelineMultisampleStateCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
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.
public VkPipelineMultisampleStateCreateInfo	alphaToCoverageEnable(boolean value) Sets the specified value to the `alphaToCoverageEnable` field.
public boolean	alphaToOneEnable() controls whether the alpha component of the fragment’s first color output is replaced with one as described in Multisample Coverage.
public VkPipelineMultisampleStateCreateInfo	alphaToOneEnable(boolean value) Sets the specified value to the `alphaToOneEnable` field.
public static VkPipelineMultisampleStateCreateInfo	calloc() Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated with `memCalloc`.
public static VkPipelineMultisampleStateCreateInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated with `memCalloc`.
public static VkPipelineMultisampleStateCreateInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPipelineMultisampleStateCreateInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPipelineMultisampleStateCreateInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineMultisampleStateCreateInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineMultisampleStateCreateInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineMultisampleStateCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkPipelineMultisampleStateCreateInfo	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkPipelineMultisampleStateCreateInfo	create() Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated with `BufferUtils`.
public static VkPipelineMultisampleStateCreateInfo	create(long address) Returns a new `VkPipelineMultisampleStateCreateInfo` instance for the specified memory address.
public static VkPipelineMultisampleStateCreateInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated with `BufferUtils`.
public static VkPipelineMultisampleStateCreateInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPipelineMultisampleStateCreateInfo.Buffer` instance at the specified memory.
public static VkPipelineMultisampleStateCreateInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPipelineMultisampleStateCreateInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() reserved for future use.
public VkPipelineMultisampleStateCreateInfo	flags(int value) Sets the specified value to the `flags` field.
public static VkPipelineMultisampleStateCreateInfo	malloc() Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated with `memAlloc`.
public static VkPipelineMultisampleStateCreateInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated with `memAlloc`.
public static VkPipelineMultisampleStateCreateInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineMultisampleStateCreateInfo` instance allocated on the specified `MemoryStack`.
public static VkPipelineMultisampleStateCreateInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineMultisampleStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VkPipelineMultisampleStateCreateInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineMultisampleStateCreateInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineMultisampleStateCreateInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineMultisampleStateCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public float	minSampleShading() specifies a minimum fraction of sample shading if `sampleShadingEnable` is set to `TRUE`.
public VkPipelineMultisampleStateCreateInfo	minSampleShading(float value) Sets the specified value to the `minSampleShading` field.
public static int	nalphaToCoverageEnable(long struct) Unsafe version of `alphaToCoverageEnable`.
public static void	nalphaToCoverageEnable(long struct, int value) Unsafe version of `alphaToCoverageEnable`.
public static int	nalphaToOneEnable(long struct) Unsafe version of `alphaToOneEnable`.
public static void	nalphaToOneEnable(long struct, int value) Unsafe version of `alphaToOneEnable`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static float	nminSampleShading(long struct) Unsafe version of `minSampleShading`.
public static void	nminSampleShading(long struct, float value) Unsafe version of `minSampleShading`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static IntBuffer	npSampleMask(long struct, int capacity) Unsafe version of `pSampleMask`.
public static void	npSampleMask(long struct, IntBuffer value) Unsafe version of `pSampleMask`.
public static int	nrasterizationSamples(long struct) Unsafe version of `rasterizationSamples`.
public static void	nrasterizationSamples(long struct, int value) Unsafe version of `rasterizationSamples`.
public static int	nsampleShadingEnable(long struct) Unsafe version of `sampleShadingEnable`.
public static void	nsampleShadingEnable(long struct, int value) Unsafe version of `sampleShadingEnable`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkPipelineMultisampleStateCreateInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkPipelineMultisampleStateCreateInfo	pNext(VkPipelineCoverageModulationStateCreateInfoNV value) Prepends the specified `VkPipelineCoverageModulationStateCreateInfoNV` value to the `pNext` chain.
public VkPipelineMultisampleStateCreateInfo	pNext(VkPipelineCoverageReductionStateCreateInfoNV value) Prepends the specified `VkPipelineCoverageReductionStateCreateInfoNV` value to the `pNext` chain.
public VkPipelineMultisampleStateCreateInfo	pNext(VkPipelineCoverageToColorStateCreateInfoNV value) Prepends the specified `VkPipelineCoverageToColorStateCreateInfoNV` value to the `pNext` chain.
public VkPipelineMultisampleStateCreateInfo	pNext(VkPipelineSampleLocationsStateCreateInfoEXT value) Prepends the specified `VkPipelineSampleLocationsStateCreateInfoEXT` value to the `pNext` chain.
public IntBuffer	Returns: a pointer to an array of `VkSampleMask` values used in the sample mask test. pSampleMask(int the number of elements in the returned buffer capacity)
public VkPipelineMultisampleStateCreateInfo	pSampleMask(IntBuffer value) Sets the address of the specified `IntBuffer` to the `pSampleMask` field.
public int	rasterizationSamples() a `VkSampleCountFlagBits` value specifying the number of samples used in rasterization.
public VkPipelineMultisampleStateCreateInfo	rasterizationSamples(int value) Sets the specified value to the `rasterizationSamples` field.
public boolean	sampleShadingEnable() can be used to enable Sample Shading.
public VkPipelineMultisampleStateCreateInfo	sampleShadingEnable(boolean value) Sets the specified value to the `sampleShadingEnable` field.
public VkPipelineMultisampleStateCreateInfo	set(int sType, long pNext, int flags, int rasterizationSamples, boolean sampleShadingEnable, float minSampleShading, IntBuffer pSampleMask, boolean alphaToCoverageEnable, boolean alphaToOneEnable) Initializes this struct with the specified values.
public VkPipelineMultisampleStateCreateInfo	Returns: this struct set(VkPipelineMultisampleStateCreateInfo the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkPipelineMultisampleStateCreateInfo	sType(int value) Sets the specified value to the `sType` field.
public VkPipelineMultisampleStateCreateInfo	sType$Default() Sets the `STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO` value to the `sType` field.

public Class VkPipelineMultisampleStateCreateInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary