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
sTypemust beSTRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFOpNextmust beNULLflagsmust be 0polygonModemust be a validVkPolygonModevaluecullModemust be a valid combination ofVkCullModeFlagBitsvaluesfrontFacemust be a validVkFrontFacevalue- If the depth clamping feature is not enabled,
depthClampEnablemust beFALSE - If the non-solid fill modes feature is not enabled,
polygonModemust bePOLYGON_MODE_FILL
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFOpNext– 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_FILLPOLYGON_MODE_LINEPOLYGON_MODE_POINTcullMode– the triangle facing direction used for primitive culling. One of:CULL_MODE_BACK_BITCULL_MODE_FRONT_AND_BACKCULL_MODE_FRONT_BITCULL_MODE_NONEfrontFace– the front-facing triangle orientation to be used for culling. One of:FRONT_FACE_CLOCKWISEFRONT_FACE_COUNTER_CLOCKWISEdepthBiasEnable– 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 classVkPipelineRasterizationStateCreateInfo.BufferAn array ofVkPipelineRasterizationStateCreateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkPipelineRasterizationStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkPipelineRasterizationStateCreateInfocalloc()Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated withmemCalloc.static VkPipelineRasterizationStateCreateInfo.Buffercalloc(int capacity)Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated withmemCalloc.static VkPipelineRasterizationStateCreateInfocallocStack()Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineRasterizationStateCreateInfo.BuffercallocStack(int capacity)Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineRasterizationStateCreateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineRasterizationStateCreateInfocallocStack(MemoryStack stack)Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineRasterizationStateCreateInfocreate()Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated withBufferUtils.static VkPipelineRasterizationStateCreateInfo.Buffercreate(int capacity)Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated withBufferUtils.static VkPipelineRasterizationStateCreateInfocreate(long address)Returns a newVkPipelineRasterizationStateCreateInfoinstance for the specified memory address ornullif the address isNULL.static VkPipelineRasterizationStateCreateInfo.Buffercreate(long address, int capacity)Create aVkPipelineRasterizationStateCreateInfo.Bufferinstance at the specified memory.intcullMode()Returns the value of thecullModefield.VkPipelineRasterizationStateCreateInfocullMode(int value)Sets the specified value to thecullModefield.floatdepthBiasClamp()Returns the value of thedepthBiasClampfield.VkPipelineRasterizationStateCreateInfodepthBiasClamp(float value)Sets the specified value to thedepthBiasClampfield.floatdepthBiasConstantFactor()Returns the value of thedepthBiasConstantFactorfield.VkPipelineRasterizationStateCreateInfodepthBiasConstantFactor(float value)Sets the specified value to thedepthBiasConstantFactorfield.intdepthBiasEnable()Returns the value of thedepthBiasEnablefield.VkPipelineRasterizationStateCreateInfodepthBiasEnable(int value)Sets the specified value to thedepthBiasEnablefield.floatdepthBiasSlopeFactor()Returns the value of thedepthBiasSlopeFactorfield.VkPipelineRasterizationStateCreateInfodepthBiasSlopeFactor(float value)Sets the specified value to thedepthBiasSlopeFactorfield.intdepthClampEnable()Returns the value of thedepthClampEnablefield.VkPipelineRasterizationStateCreateInfodepthClampEnable(int value)Sets the specified value to thedepthClampEnablefield.intflags()Returns the value of theflagsfield.VkPipelineRasterizationStateCreateInfoflags(int value)Sets the specified value to theflagsfield.intfrontFace()Returns the value of thefrontFacefield.VkPipelineRasterizationStateCreateInfofrontFace(int value)Sets the specified value to thefrontFacefield.floatlineWidth()Returns the value of thelineWidthfield.VkPipelineRasterizationStateCreateInfolineWidth(float value)Sets the specified value to thelineWidthfield.static VkPipelineRasterizationStateCreateInfomalloc()Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated withmemAlloc.static VkPipelineRasterizationStateCreateInfo.Buffermalloc(int capacity)Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated withmemAlloc.static VkPipelineRasterizationStateCreateInfomallocStack()Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated on the thread-localMemoryStack.static VkPipelineRasterizationStateCreateInfo.BuffermallocStack(int capacity)Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkPipelineRasterizationStateCreateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineRasterizationStateCreateInfomallocStack(MemoryStack stack)Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated on the specifiedMemoryStack.VkPipelineRasterizationStateCreateInfonset(long struct)Unsafe version ofset.longpNext()Returns the value of thepNextfield.VkPipelineRasterizationStateCreateInfopNext(long value)Sets the specified value to thepNextfield.intpolygonMode()Returns the value of thepolygonModefield.VkPipelineRasterizationStateCreateInfopolygonMode(int value)Sets the specified value to thepolygonModefield.intrasterizerDiscardEnable()Returns the value of therasterizerDiscardEnablefield.VkPipelineRasterizationStateCreateInforasterizerDiscardEnable(int value)Sets the specified value to therasterizerDiscardEnablefield.VkPipelineRasterizationStateCreateInfoset(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.VkPipelineRasterizationStateCreateInfoset(VkPipelineRasterizationStateCreateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkPipelineRasterizationStateCreateInfosType(int value)Sets the specified value to thesTypefield.-
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 aVkPipelineRasterizationStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
depthClampEnable
public int depthClampEnable()
Returns the value of thedepthClampEnablefield.
-
rasterizerDiscardEnable
public int rasterizerDiscardEnable()
Returns the value of therasterizerDiscardEnablefield.
-
polygonMode
public int polygonMode()
Returns the value of thepolygonModefield.
-
cullMode
public int cullMode()
Returns the value of thecullModefield.
-
frontFace
public int frontFace()
Returns the value of thefrontFacefield.
-
depthBiasEnable
public int depthBiasEnable()
Returns the value of thedepthBiasEnablefield.
-
depthBiasConstantFactor
public float depthBiasConstantFactor()
Returns the value of thedepthBiasConstantFactorfield.
-
depthBiasClamp
public float depthBiasClamp()
Returns the value of thedepthBiasClampfield.
-
depthBiasSlopeFactor
public float depthBiasSlopeFactor()
Returns the value of thedepthBiasSlopeFactorfield.
-
lineWidth
public float lineWidth()
Returns the value of thelineWidthfield.
-
sType
public VkPipelineRasterizationStateCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkPipelineRasterizationStateCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkPipelineRasterizationStateCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
depthClampEnable
public VkPipelineRasterizationStateCreateInfo depthClampEnable(int value)
Sets the specified value to thedepthClampEnablefield.
-
rasterizerDiscardEnable
public VkPipelineRasterizationStateCreateInfo rasterizerDiscardEnable(int value)
Sets the specified value to therasterizerDiscardEnablefield.
-
polygonMode
public VkPipelineRasterizationStateCreateInfo polygonMode(int value)
Sets the specified value to thepolygonModefield.
-
cullMode
public VkPipelineRasterizationStateCreateInfo cullMode(int value)
Sets the specified value to thecullModefield.
-
frontFace
public VkPipelineRasterizationStateCreateInfo frontFace(int value)
Sets the specified value to thefrontFacefield.
-
depthBiasEnable
public VkPipelineRasterizationStateCreateInfo depthBiasEnable(int value)
Sets the specified value to thedepthBiasEnablefield.
-
depthBiasConstantFactor
public VkPipelineRasterizationStateCreateInfo depthBiasConstantFactor(float value)
Sets the specified value to thedepthBiasConstantFactorfield.
-
depthBiasClamp
public VkPipelineRasterizationStateCreateInfo depthBiasClamp(float value)
Sets the specified value to thedepthBiasClampfield.
-
depthBiasSlopeFactor
public VkPipelineRasterizationStateCreateInfo depthBiasSlopeFactor(float value)
Sets the specified value to thedepthBiasSlopeFactorfield.
-
lineWidth
public VkPipelineRasterizationStateCreateInfo lineWidth(float value)
Sets the specified value to thelineWidthfield.
-
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 newVkPipelineRasterizationStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineRasterizationStateCreateInfo calloc()
Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineRasterizationStateCreateInfo create()
Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated withBufferUtils.
-
create
public static VkPipelineRasterizationStateCreateInfo create(long address)
Returns a newVkPipelineRasterizationStateCreateInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkPipelineRasterizationStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineRasterizationStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineRasterizationStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineRasterizationStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineRasterizationStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkPipelineRasterizationStateCreateInfo mallocStack()
Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPipelineRasterizationStateCreateInfo callocStack()
Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPipelineRasterizationStateCreateInfo mallocStack(MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPipelineRasterizationStateCreateInfo callocStack(MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfoinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPipelineRasterizationStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPipelineRasterizationStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineRasterizationStateCreateInfo.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-