Class VkPipelineDiscardRectangleStateCreateInfoEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
If the DYNAMIC_STATE_DISCARD_RECTANGLE_EXT dynamic state is enabled for a pipeline, the pDiscardRectangles member is ignored. If the DYNAMIC_STATE_DISCARD_RECTANGLE_ENABLE_EXT dynamic state is not enabled for the pipeline the presence of this structure in the VkGraphicsPipelineCreateInfo chain, and a discardRectangleCount greater than zero, implicitly enables discard rectangles in the pipeline, otherwise discard rectangles must enabled or disabled by CmdSetDiscardRectangleEnableEXT. If the DYNAMIC_STATE_DISCARD_RECTANGLE_MODE_EXT dynamic state is enabled for the pipeline, the discardRectangleMode member is ignored, and the discard rectangle mode must be set by CmdSetDiscardRectangleModeEXT.
When this structure is included in the pNext chain of VkGraphicsPipelineCreateInfo, it defines parameters of the discard rectangle test. If the DYNAMIC_STATE_DISCARD_RECTANGLE_EXT dynamic state is not enabled, and this structure is not included in the pNext chain, it is equivalent to specifying this structure with a discardRectangleCount of 0.
Valid Usage
discardRectangleCountmust be less than or equal toVkPhysicalDeviceDiscardRectanglePropertiesEXT::maxDiscardRectangles
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXTflagsmust be 0discardRectangleModemust be a validVkDiscardRectangleModeEXTvalue
See Also
Layout
struct VkPipelineDiscardRectangleStateCreateInfoEXT {
VkStructureType sType();
void const * pNext();
VkPipelineDiscardRectangleStateCreateFlagsEXT flags();
VkDiscardRectangleModeEXT discardRectangleMode();
uint32_t discardRectangleCount();
VkRect2D const * pDiscardRectangles();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPipelineDiscardRectangleStateCreateInfoEXTstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates aVkPipelineDiscardRectangleStateCreateInfoEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance at the specified memory.static @Nullable VkPipelineDiscardRectangleStateCreateInfoEXTcreateSafe(long address) static @Nullable VkPipelineDiscardRectangleStateCreateInfoEXT.BuffercreateSafe(long address, int capacity) intthe number of discard rectangles to use.discardRectangleCount(int value) Sets the specified value to thediscardRectangleCount()field.intaVkDiscardRectangleModeEXTvalue determining whether the discard rectangle test is inclusive or exclusive.discardRectangleMode(int value) Sets the specified value to thediscardRectangleMode()field.intflags()reserved for future use.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intndiscardRectangleCount(long struct) Unsafe version ofdiscardRectangleCount().static voidndiscardRectangleCount(long struct, int value) Sets the specified value to thediscardRectangleCountfield of the specifiedstruct.static intndiscardRectangleMode(long struct) Unsafe version ofdiscardRectangleMode().static voidndiscardRectangleMode(long struct, int value) Unsafe version ofdiscardRectangleMode.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static @Nullable VkRect2D.BuffernpDiscardRectangles(long struct) Unsafe version ofpDiscardRectangles().static voidnpDiscardRectangles(long struct, @Nullable VkRect2D.Buffer value) Unsafe version ofpDiscardRectangles.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.@Nullable VkRect2D.Buffera pointer to an array ofVkRect2Dstructures defining discard rectangles.pDiscardRectangles(@Nullable VkRect2D.Buffer value) Sets the address of the specifiedVkRect2D.Bufferto thepDiscardRectangles()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int flags, int discardRectangleMode, int discardRectangleCount, @Nullable VkRect2D.Buffer pDiscardRectangles) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXTvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
DISCARDRECTANGLEMODE
public static final int DISCARDRECTANGLEMODEThe struct member offsets. -
DISCARDRECTANGLECOUNT
public static final int DISCARDRECTANGLECOUNTThe struct member offsets. -
PDISCARDRECTANGLES
public static final int PDISCARDRECTANGLESThe struct member offsets.
-
-
Constructor Details
-
VkPipelineDiscardRectangleStateCreateInfoEXT
Creates aVkPipelineDiscardRectangleStateCreateInfoEXTinstance 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkPipelineDiscardRectangleStateCreateInfoEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()reserved for future use. -
discardRectangleMode
public int discardRectangleMode()aVkDiscardRectangleModeEXTvalue determining whether the discard rectangle test is inclusive or exclusive. -
discardRectangleCount
public int discardRectangleCount()the number of discard rectangles to use. -
pDiscardRectangles
a pointer to an array ofVkRect2Dstructures defining discard rectangles. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
discardRectangleMode
Sets the specified value to thediscardRectangleMode()field. -
discardRectangleCount
Sets the specified value to thediscardRectangleCount()field. -
pDiscardRectangles
public VkPipelineDiscardRectangleStateCreateInfoEXT pDiscardRectangles(@Nullable VkRect2D.Buffer value) Sets the address of the specifiedVkRect2D.Bufferto thepDiscardRectangles()field. -
set
public VkPipelineDiscardRectangleStateCreateInfoEXT set(int sType, long pNext, int flags, int discardRectangleMode, int discardRectangleCount, @Nullable VkRect2D.Buffer pDiscardRectangles) Initializes this struct with the specified values. -
set
public VkPipelineDiscardRectangleStateCreateInfoEXT set(VkPipelineDiscardRectangleStateCreateInfoEXT src) Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated withBufferUtils. -
create
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer create(long address, int capacity) Create aVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineDiscardRectangleStateCreateInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineDiscardRectangleStateCreateInfoEXT callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer mallocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer callocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
public static VkPipelineDiscardRectangleStateCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPipelineDiscardRectangleStateCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
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(). -
ndiscardRectangleMode
public static int ndiscardRectangleMode(long struct) Unsafe version ofdiscardRectangleMode(). -
ndiscardRectangleCount
public static int ndiscardRectangleCount(long struct) Unsafe version ofdiscardRectangleCount(). -
npDiscardRectangles
Unsafe version ofpDiscardRectangles(). -
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. -
ndiscardRectangleMode
public static void ndiscardRectangleMode(long struct, int value) Unsafe version ofdiscardRectangleMode. -
ndiscardRectangleCount
public static void ndiscardRectangleCount(long struct, int value) Sets the specified value to thediscardRectangleCountfield of the specifiedstruct. -
npDiscardRectangles
Unsafe version ofpDiscardRectangles.
-