Class VkPipelineDiscardRectangleStateCreateInfoEXT
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,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
discardRectangleCount
must be less than or equal toVkPhysicalDeviceDiscardRectanglePropertiesEXT
::maxDiscardRectangles
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT
flags
must be 0discardRectangleMode
must be a validVkDiscardRectangleModeEXT
value
See Also
Layout
struct VkPipelineDiscardRectangleStateCreateInfoEXT {
VkStructureType sType()
;
void const * pNext()
;
VkPipelineDiscardRectangleStateCreateFlagsEXT flags()
;
VkDiscardRectangleModeEXT discardRectangleMode()
;
uint32_t discardRectangleCount()
;
VkRect2D
const * pDiscardRectangles()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkPipelineDiscardRectangleStateCreateInfoEXT
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionCreates aVkPipelineDiscardRectangleStateCreateInfoEXT
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance for the specified memory address.create
(long address, int capacity) Create aVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
the number of discard rectangles to use.discardRectangleCount
(int value) Sets the specified value to thediscardRectangleCount()
field.int
aVkDiscardRectangleModeEXT
value determining whether the discard rectangle test is inclusive or exclusive.discardRectangleMode
(int value) Sets the specified value to thediscardRectangleMode()
field.int
flags()
reserved for future use.flags
(int value) Sets the specified value to theflags()
field.malloc()
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static int
ndiscardRectangleCount
(long struct) Unsafe version ofdiscardRectangleCount()
.static void
ndiscardRectangleCount
(long struct, int value) Sets the specified value to thediscardRectangleCount
field of the specifiedstruct
.static int
ndiscardRectangleMode
(long struct) Unsafe version ofdiscardRectangleMode()
.static void
ndiscardRectangleMode
(long struct, int value) Unsafe version ofdiscardRectangleMode
.static int
nflags
(long struct) Unsafe version offlags()
.static void
nflags
(long struct, int value) Unsafe version offlags
.static VkRect2D.Buffer
npDiscardRectangles
(long struct) Unsafe version ofpDiscardRectangles()
.static void
npDiscardRectangles
(long struct, VkRect2D.Buffer value) Unsafe version ofpDiscardRectangles
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.a pointer to an array ofVkRect2D
structures defining discard rectangles.Sets the address of the specifiedVkRect2D.Buffer
to thepDiscardRectangles()
field.long
pNext()
NULL
or 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, VkRect2D.Buffer pDiscardRectangles) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT
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, 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 aVkPipelineDiscardRectangleStateCreateInfoEXT
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkPipelineDiscardRectangleStateCreateInfoEXT>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
flags
public int flags()reserved for future use. -
discardRectangleMode
public int discardRectangleMode()aVkDiscardRectangleModeEXT
value 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 ofVkRect2D
structures defining discard rectangles. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT
value 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.Buffer
to 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 newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated withBufferUtils
. -
create
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer create(long address, int capacity) Create aVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static 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(MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
@Deprecated public static VkPipelineDiscardRectangleStateCreateInfoEXT callocStack(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, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a newVkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and 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 thediscardRectangleCount
field of the specifiedstruct
. -
npDiscardRectangles
Unsafe version ofpDiscardRectangles
.
-