Package org.lwjgl.vulkan
Class VkPipelineRasterizationStateCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineRasterizationStateCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkPipelineRasterizationStateCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about rasterization as part of graphics pipeline creation.
Valid Usage
sType
must beSTRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO
pNext
must beNULL
flags
must be 0polygonMode
must be a validVkPolygonMode
valuecullMode
must be a valid combination ofVkCullModeFlagBits
valuesfrontFace
must be a validVkFrontFace
value- If the depth clamping feature is not enabled,
depthClampEnable
must beFALSE
- If the non-solid fill modes feature is not enabled,
polygonMode
must bePOLYGON_MODE_FILL
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO
pNext
– reserved for use by extensionsflags
– reserved for future usedepthClampEnable
– controls whether to clamp the fragment’s depth values instead of clipping primitives to the z planes of the frustumrasterizerDiscardEnable
– controls whether primitives are discarded immediately before the rasterization stagepolygonMode
– the triangle rendering mode. One of:POLYGON_MODE_FILL
POLYGON_MODE_LINE
POLYGON_MODE_POINT
cullMode
– the triangle facing direction used for primitive culling. One of:CULL_MODE_BACK_BIT
CULL_MODE_FRONT_AND_BACK
CULL_MODE_FRONT_BIT
CULL_MODE_NONE
frontFace
– the front-facing triangle orientation to be used for culling. One of:FRONT_FACE_CLOCKWISE
FRONT_FACE_COUNTER_CLOCKWISE
depthBiasEnable
– controls whether to bias fragment depth valuesdepthBiasConstantFactor
– a scalar factor controlling the constant depth value added to each fragmentdepthBiasClamp
– the maximum (or minimum) depth bias of a fragmentdepthBiasSlopeFactor
– a scalar factor applied to a fragment’s slope in depth bias calculationslineWidth
– the width of rasterized line segments
Layout
struct VkPipelineRasterizationStateCreateInfo { VkStructureType sType; const void * pNext; VkPipelineRasterizationStateCreateFlags flags; VkBool32 depthClampEnable; VkBool32 rasterizerDiscardEnable; VkPolygonMode polygonMode; VkCullModeFlags cullMode; VkFrontFace frontFace; VkBool32 depthBiasEnable; float depthBiasConstantFactor; float depthBiasClamp; float depthBiasSlopeFactor; float lineWidth; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkPipelineRasterizationStateCreateInfo.Buffer
An array ofVkPipelineRasterizationStateCreateInfo
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 VkPipelineRasterizationStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineRasterizationStateCreateInfo
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 static VkPipelineRasterizationStateCreateInfo
calloc()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated withmemCalloc
.static VkPipelineRasterizationStateCreateInfo.Buffer
calloc(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated withmemCalloc
.static VkPipelineRasterizationStateCreateInfo
callocStack()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineRasterizationStateCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineRasterizationStateCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineRasterizationStateCreateInfo
callocStack(MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineRasterizationStateCreateInfo
create()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated withBufferUtils
.static VkPipelineRasterizationStateCreateInfo.Buffer
create(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated withBufferUtils
.static VkPipelineRasterizationStateCreateInfo
create(long address)
Returns a newVkPipelineRasterizationStateCreateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkPipelineRasterizationStateCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineRasterizationStateCreateInfo.Buffer
instance at the specified memory.int
cullMode()
Returns the value of thecullMode
field.VkPipelineRasterizationStateCreateInfo
cullMode(int value)
Sets the specified value to thecullMode
field.float
depthBiasClamp()
Returns the value of thedepthBiasClamp
field.VkPipelineRasterizationStateCreateInfo
depthBiasClamp(float value)
Sets the specified value to thedepthBiasClamp
field.float
depthBiasConstantFactor()
Returns the value of thedepthBiasConstantFactor
field.VkPipelineRasterizationStateCreateInfo
depthBiasConstantFactor(float value)
Sets the specified value to thedepthBiasConstantFactor
field.int
depthBiasEnable()
Returns the value of thedepthBiasEnable
field.VkPipelineRasterizationStateCreateInfo
depthBiasEnable(int value)
Sets the specified value to thedepthBiasEnable
field.float
depthBiasSlopeFactor()
Returns the value of thedepthBiasSlopeFactor
field.VkPipelineRasterizationStateCreateInfo
depthBiasSlopeFactor(float value)
Sets the specified value to thedepthBiasSlopeFactor
field.int
depthClampEnable()
Returns the value of thedepthClampEnable
field.VkPipelineRasterizationStateCreateInfo
depthClampEnable(int value)
Sets the specified value to thedepthClampEnable
field.int
flags()
Returns the value of theflags
field.VkPipelineRasterizationStateCreateInfo
flags(int value)
Sets the specified value to theflags
field.int
frontFace()
Returns the value of thefrontFace
field.VkPipelineRasterizationStateCreateInfo
frontFace(int value)
Sets the specified value to thefrontFace
field.float
lineWidth()
Returns the value of thelineWidth
field.VkPipelineRasterizationStateCreateInfo
lineWidth(float value)
Sets the specified value to thelineWidth
field.static VkPipelineRasterizationStateCreateInfo
malloc()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated withmemAlloc
.static VkPipelineRasterizationStateCreateInfo.Buffer
malloc(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated withmemAlloc
.static VkPipelineRasterizationStateCreateInfo
mallocStack()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated on the thread-localMemoryStack
.static VkPipelineRasterizationStateCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineRasterizationStateCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineRasterizationStateCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated on the specifiedMemoryStack
.VkPipelineRasterizationStateCreateInfo
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkPipelineRasterizationStateCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.int
polygonMode()
Returns the value of thepolygonMode
field.VkPipelineRasterizationStateCreateInfo
polygonMode(int value)
Sets the specified value to thepolygonMode
field.int
rasterizerDiscardEnable()
Returns the value of therasterizerDiscardEnable
field.VkPipelineRasterizationStateCreateInfo
rasterizerDiscardEnable(int value)
Sets the specified value to therasterizerDiscardEnable
field.VkPipelineRasterizationStateCreateInfo
set(int sType, long pNext, int flags, int depthClampEnable, int rasterizerDiscardEnable, int polygonMode, int cullMode, int frontFace, int depthBiasEnable, float depthBiasConstantFactor, float depthBiasClamp, float depthBiasSlopeFactor, float lineWidth)
Initializes this struct with the specified values.VkPipelineRasterizationStateCreateInfo
set(VkPipelineRasterizationStateCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkPipelineRasterizationStateCreateInfo
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
-
VkPipelineRasterizationStateCreateInfo
public VkPipelineRasterizationStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineRasterizationStateCreateInfo
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.
-
depthClampEnable
public int depthClampEnable()
Returns the value of thedepthClampEnable
field.
-
rasterizerDiscardEnable
public int rasterizerDiscardEnable()
Returns the value of therasterizerDiscardEnable
field.
-
polygonMode
public int polygonMode()
Returns the value of thepolygonMode
field.
-
cullMode
public int cullMode()
Returns the value of thecullMode
field.
-
frontFace
public int frontFace()
Returns the value of thefrontFace
field.
-
depthBiasEnable
public int depthBiasEnable()
Returns the value of thedepthBiasEnable
field.
-
depthBiasConstantFactor
public float depthBiasConstantFactor()
Returns the value of thedepthBiasConstantFactor
field.
-
depthBiasClamp
public float depthBiasClamp()
Returns the value of thedepthBiasClamp
field.
-
depthBiasSlopeFactor
public float depthBiasSlopeFactor()
Returns the value of thedepthBiasSlopeFactor
field.
-
lineWidth
public float lineWidth()
Returns the value of thelineWidth
field.
-
sType
public VkPipelineRasterizationStateCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineRasterizationStateCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkPipelineRasterizationStateCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
depthClampEnable
public VkPipelineRasterizationStateCreateInfo depthClampEnable(int value)
Sets the specified value to thedepthClampEnable
field.
-
rasterizerDiscardEnable
public VkPipelineRasterizationStateCreateInfo rasterizerDiscardEnable(int value)
Sets the specified value to therasterizerDiscardEnable
field.
-
polygonMode
public VkPipelineRasterizationStateCreateInfo polygonMode(int value)
Sets the specified value to thepolygonMode
field.
-
cullMode
public VkPipelineRasterizationStateCreateInfo cullMode(int value)
Sets the specified value to thecullMode
field.
-
frontFace
public VkPipelineRasterizationStateCreateInfo frontFace(int value)
Sets the specified value to thefrontFace
field.
-
depthBiasEnable
public VkPipelineRasterizationStateCreateInfo depthBiasEnable(int value)
Sets the specified value to thedepthBiasEnable
field.
-
depthBiasConstantFactor
public VkPipelineRasterizationStateCreateInfo depthBiasConstantFactor(float value)
Sets the specified value to thedepthBiasConstantFactor
field.
-
depthBiasClamp
public VkPipelineRasterizationStateCreateInfo depthBiasClamp(float value)
Sets the specified value to thedepthBiasClamp
field.
-
depthBiasSlopeFactor
public VkPipelineRasterizationStateCreateInfo depthBiasSlopeFactor(float value)
Sets the specified value to thedepthBiasSlopeFactor
field.
-
lineWidth
public VkPipelineRasterizationStateCreateInfo lineWidth(float value)
Sets the specified value to thelineWidth
field.
-
set
public VkPipelineRasterizationStateCreateInfo set(int sType, long pNext, int flags, int depthClampEnable, int rasterizerDiscardEnable, int polygonMode, int cullMode, int frontFace, int depthBiasEnable, float depthBiasConstantFactor, float depthBiasClamp, float depthBiasSlopeFactor, float lineWidth)
Initializes this struct with the specified values.
-
nset
public VkPipelineRasterizationStateCreateInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkPipelineRasterizationStateCreateInfo set(VkPipelineRasterizationStateCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineRasterizationStateCreateInfo malloc()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineRasterizationStateCreateInfo calloc()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineRasterizationStateCreateInfo create()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkPipelineRasterizationStateCreateInfo create(long address)
Returns a newVkPipelineRasterizationStateCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkPipelineRasterizationStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineRasterizationStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineRasterizationStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineRasterizationStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineRasterizationStateCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkPipelineRasterizationStateCreateInfo mallocStack()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineRasterizationStateCreateInfo callocStack()
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineRasterizationStateCreateInfo mallocStack(MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineRasterizationStateCreateInfo callocStack(MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPipelineRasterizationStateCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineRasterizationStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineRasterizationStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineRasterizationStateCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-