LWJGL 3.3.3 · org.lwjgl.vulkan.VkPipelineRasterizationStateCreateInfo

Structure specifying parameters of a newly created pipeline rasterization state.

Description

The application can also add a VkPipelineRasterizationStateRasterizationOrderAMD structure to the pNext chain of a VkPipelineRasterizationStateCreateInfo structure. This structure enables selecting the rasterization order to use when rendering with the corresponding graphics pipeline as described in Rasterization Order.

Valid Usage

If the depthClamp feature is not enabled, depthClampEnable must be FALSE
If the fillModeNonSolid feature is not enabled, polygonMode must be POLYGON_MODE_FILL or POLYGON_MODE_FILL_RECTANGLE_NV
If the VK_NV_fill_rectangle extension is not enabled, polygonMode must not be POLYGON_MODE_FILL_RECTANGLE_NV
If the VK_KHR_portability_subset extension is enabled, and VkPhysicalDevicePortabilitySubsetFeaturesKHR::pointPolygons is FALSE, and rasterizerDiscardEnable is FALSE, polygonMode must not be POLYGON_MODE_POINT

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PIPELINE_RASTERIZATION_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 VkDepthBiasRepresentationInfoEXT, VkPipelineRasterizationConservativeStateCreateInfoEXT, VkPipelineRasterizationDepthClipStateCreateInfoEXT, VkPipelineRasterizationLineStateCreateInfoEXT, VkPipelineRasterizationProvokingVertexStateCreateInfoEXT, VkPipelineRasterizationStateRasterizationOrderAMD, or VkPipelineRasterizationStateStreamCreateInfoEXT
The sType value of each struct in the pNext chain must be unique
flags must be 0
polygonMode must be a valid VkPolygonMode value
cullMode must be a valid combination of VkCullModeFlagBits values
frontFace must be a valid VkFrontFace value

Layout


struct VkPipelineRasterizationStateCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkPipelineRasterizationStateCreateFlags flags;
    VkBool32 depthClampEnable;
    VkBool32 rasterizerDiscardEnable;
    VkPolygonMode polygonMode;
    VkCullModeFlags cullMode;
    VkFrontFace frontFace;
    VkBool32 depthBiasEnable;
    float depthBiasConstantFactor;
    float depthBiasClamp;
    float depthBiasSlopeFactor;
    float lineWidth;
}

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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	CULLMODE The struct member offsets.
public static final int	DEPTHBIASCLAMP The struct member offsets.
public static final int	DEPTHBIASCONSTANTFACTOR The struct member offsets.
public static final int	DEPTHBIASENABLE The struct member offsets.
public static final int	DEPTHBIASSLOPEFACTOR The struct member offsets.
public static final int	DEPTHCLAMPENABLE The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	FRONTFACE The struct member offsets.
public static final int	LINEWIDTH The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	POLYGONMODE The struct member offsets.
public static final int	RASTERIZERDISCARDENABLE 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	VkPipelineRasterizationStateCreateInfo(long address, ByteBuffer container)
public	VkPipelineRasterizationStateCreateInfo(ByteBuffer container) Creates a `VkPipelineRasterizationStateCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkPipelineRasterizationStateCreateInfo	calloc() Returns a new `VkPipelineRasterizationStateCreateInfo` instance allocated with `memCalloc`.
public static VkPipelineRasterizationStateCreateInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkPipelineRasterizationStateCreateInfo.Buffer` instance allocated with `memCalloc`.
public static VkPipelineRasterizationStateCreateInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineRasterizationStateCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPipelineRasterizationStateCreateInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineRasterizationStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPipelineRasterizationStateCreateInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineRasterizationStateCreateInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineRasterizationStateCreateInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineRasterizationStateCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkPipelineRasterizationStateCreateInfo	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 VkPipelineRasterizationStateCreateInfo	create() Returns a new `VkPipelineRasterizationStateCreateInfo` instance allocated with `BufferUtils`.
public static VkPipelineRasterizationStateCreateInfo	create(long address) Returns a new `VkPipelineRasterizationStateCreateInfo` instance for the specified memory address.
public static VkPipelineRasterizationStateCreateInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkPipelineRasterizationStateCreateInfo.Buffer` instance allocated with `BufferUtils`.
public static VkPipelineRasterizationStateCreateInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPipelineRasterizationStateCreateInfo.Buffer` instance at the specified memory.
public static VkPipelineRasterizationStateCreateInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPipelineRasterizationStateCreateInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	cullMode() the triangle facing direction used for primitive culling.
public VkPipelineRasterizationStateCreateInfo	cullMode(int value) Sets the specified value to the `cullMode` field.
public float	depthBiasClamp() the maximum (or minimum) depth bias of a fragment.
public VkPipelineRasterizationStateCreateInfo	depthBiasClamp(float value) Sets the specified value to the `depthBiasClamp` field.
public float	depthBiasConstantFactor() a scalar factor controlling the constant depth value added to each fragment.
public VkPipelineRasterizationStateCreateInfo	depthBiasConstantFactor(float value) Sets the specified value to the `depthBiasConstantFactor` field.
public boolean	depthBiasEnable() controls whether to bias fragment depth values.
public VkPipelineRasterizationStateCreateInfo	depthBiasEnable(boolean value) Sets the specified value to the `depthBiasEnable` field.
public float	depthBiasSlopeFactor() a scalar factor applied to a fragment’s slope in depth bias calculations.
public VkPipelineRasterizationStateCreateInfo	depthBiasSlopeFactor(float value) Sets the specified value to the `depthBiasSlopeFactor` field.
public boolean	depthClampEnable() controls whether to clamp the fragment’s depth values as described in Depth Test.
public VkPipelineRasterizationStateCreateInfo	depthClampEnable(boolean value) Sets the specified value to the `depthClampEnable` field.
public int	flags() reserved for future use.
public VkPipelineRasterizationStateCreateInfo	flags(int value) Sets the specified value to the `flags` field.
public int	frontFace() a `VkFrontFace` value specifying the front-facing triangle orientation to be used for culling.
public VkPipelineRasterizationStateCreateInfo	frontFace(int value) Sets the specified value to the `frontFace` field.
public float	lineWidth() the width of rasterized line segments.
public VkPipelineRasterizationStateCreateInfo	lineWidth(float value) Sets the specified value to the `lineWidth` field.
public static VkPipelineRasterizationStateCreateInfo	malloc() Returns a new `VkPipelineRasterizationStateCreateInfo` instance allocated with `memAlloc`.
public static VkPipelineRasterizationStateCreateInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkPipelineRasterizationStateCreateInfo.Buffer` instance allocated with `memAlloc`.
public static VkPipelineRasterizationStateCreateInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineRasterizationStateCreateInfo` instance allocated on the specified `MemoryStack`.
public static VkPipelineRasterizationStateCreateInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineRasterizationStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VkPipelineRasterizationStateCreateInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineRasterizationStateCreateInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineRasterizationStateCreateInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineRasterizationStateCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	ncullMode(long struct) Unsafe version of `cullMode`.
public static void	ncullMode(long struct, int value) Unsafe version of `cullMode`.
public static float	ndepthBiasClamp(long struct) Unsafe version of `depthBiasClamp`.
public static void	ndepthBiasClamp(long struct, float value) Unsafe version of `depthBiasClamp`.
public static float	ndepthBiasConstantFactor(long struct) Unsafe version of `depthBiasConstantFactor`.
public static void	ndepthBiasConstantFactor(long struct, float value) Unsafe version of `depthBiasConstantFactor`.
public static int	ndepthBiasEnable(long struct) Unsafe version of `depthBiasEnable`.
public static void	ndepthBiasEnable(long struct, int value) Unsafe version of `depthBiasEnable`.
public static float	ndepthBiasSlopeFactor(long struct) Unsafe version of `depthBiasSlopeFactor`.
public static void	ndepthBiasSlopeFactor(long struct, float value) Unsafe version of `depthBiasSlopeFactor`.
public static int	ndepthClampEnable(long struct) Unsafe version of `depthClampEnable`.
public static void	ndepthClampEnable(long struct, int value) Unsafe version of `depthClampEnable`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static int	nfrontFace(long struct) Unsafe version of `frontFace`.
public static void	nfrontFace(long struct, int value) Unsafe version of `frontFace`.
public static float	nlineWidth(long struct) Unsafe version of `lineWidth`.
public static void	nlineWidth(long struct, float value) Unsafe version of `lineWidth`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	npolygonMode(long struct) Unsafe version of `polygonMode`.
public static void	npolygonMode(long struct, int value) Unsafe version of `polygonMode`.
public static int	nrasterizerDiscardEnable(long struct) Unsafe version of `rasterizerDiscardEnable`.
public static void	nrasterizerDiscardEnable(long struct, int value) Unsafe version of `rasterizerDiscardEnable`.
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 VkPipelineRasterizationStateCreateInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkPipelineRasterizationStateCreateInfo	pNext(VkDepthBiasRepresentationInfoEXT value) Prepends the specified `VkDepthBiasRepresentationInfoEXT` value to the `pNext` chain.
public VkPipelineRasterizationStateCreateInfo	pNext(VkPipelineRasterizationConservativeStateCreateInfoEXT value) Prepends the specified `VkPipelineRasterizationConservativeStateCreateInfoEXT` value to the `pNext` chain.
public VkPipelineRasterizationStateCreateInfo	pNext(VkPipelineRasterizationDepthClipStateCreateInfoEXT value) Prepends the specified `VkPipelineRasterizationDepthClipStateCreateInfoEXT` value to the `pNext` chain.
public VkPipelineRasterizationStateCreateInfo	pNext(VkPipelineRasterizationLineStateCreateInfoEXT value) Prepends the specified `VkPipelineRasterizationLineStateCreateInfoEXT` value to the `pNext` chain.
public VkPipelineRasterizationStateCreateInfo	pNext(VkPipelineRasterizationProvokingVertexStateCreateInfoEXT value) Prepends the specified `VkPipelineRasterizationProvokingVertexStateCreateInfoEXT` value to the `pNext` chain.
public VkPipelineRasterizationStateCreateInfo	pNext(VkPipelineRasterizationStateRasterizationOrderAMD value) Prepends the specified `VkPipelineRasterizationStateRasterizationOrderAMD` value to the `pNext` chain.
public VkPipelineRasterizationStateCreateInfo	pNext(VkPipelineRasterizationStateStreamCreateInfoEXT value) Prepends the specified `VkPipelineRasterizationStateStreamCreateInfoEXT` value to the `pNext` chain.
public int	polygonMode() the triangle rendering mode.
public VkPipelineRasterizationStateCreateInfo	polygonMode(int value) Sets the specified value to the `polygonMode` field.
public boolean	rasterizerDiscardEnable() controls whether primitives are discarded immediately before the rasterization stage.
public VkPipelineRasterizationStateCreateInfo	rasterizerDiscardEnable(boolean value) Sets the specified value to the `rasterizerDiscardEnable` field.
public VkPipelineRasterizationStateCreateInfo	set(int sType, long pNext, int flags, boolean depthClampEnable, boolean rasterizerDiscardEnable, int polygonMode, int cullMode, int frontFace, boolean depthBiasEnable, float depthBiasConstantFactor, float depthBiasClamp, float depthBiasSlopeFactor, float lineWidth) Initializes this struct with the specified values.
public VkPipelineRasterizationStateCreateInfo	Returns: this struct set(VkPipelineRasterizationStateCreateInfo 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 VkPipelineRasterizationStateCreateInfo	sType(int value) Sets the specified value to the `sType` field.
public VkPipelineRasterizationStateCreateInfo	sType$Default() Sets the `STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO` value to the `sType` field.

public Class VkPipelineRasterizationStateCreateInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary