java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkPipelineDiscardRectangleStateCreateInfoEXT

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPipelineDiscardRectangleStateCreateInfoEXT
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying discard rectangle.
Description

If the DYNAMIC_STATE_DISCARD_RECTANGLE_EXT dynamic state is enabled for a pipeline, the pDiscardRectangles member is ignored.

When this structure is included in the pNext chain of VkGraphicsPipelineCreateInfo, it defines parameters of the discard rectangle test. If 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 to VkPhysicalDeviceDiscardRectanglePropertiesEXT::maxDiscardRectangles
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT
- flags must be 0
- discardRectangleMode must be a valid VkDiscardRectangleModeEXT value
See Also

VkRect2D

Layout
```
 struct VkPipelineDiscardRectangleStateCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkPipelineDiscardRectangleStateCreateFlagsEXT flags();
     VkDiscardRectangleModeEXT discardRectangleMode();
     uint32_t discardRectangleCount();
     VkRect2D const * pDiscardRectangles();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer
An array of VkPipelineDiscardRectangleStateCreateInfoEXT structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`DISCARDRECTANGLECOUNT DISCARDRECTANGLEMODE FLAGS PDISCARDRECTANGLES PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkPipelineDiscardRectangleStateCreateInfoEXT(java.nio.ByteBuffer container)`	Creates a `VkPipelineDiscardRectangleStateCreateInfoEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`calloc()`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated with `memCalloc`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`calloc(int capacity)`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance allocated with `memCalloc`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`callocStack()`	Deprecated.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`create()`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated with `BufferUtils`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`create(int capacity)`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`create(long address)`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance for the specified memory address.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`create(long address, int capacity)`	Create a `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance at the specified memory.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`discardRectangleCount()`	the number of discard rectangles to use.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`discardRectangleCount(int value)`	Sets the specified value to the `discardRectangleCount()` field.
`int`	`discardRectangleMode()`	a `VkDiscardRectangleModeEXT` value determining whether the discard rectangle test is inclusive or exclusive.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`discardRectangleMode(int value)`	Sets the specified value to the `discardRectangleMode()` field.
`int`	`flags()`	reserved for future use.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`flags(int value)`	Sets the specified value to the `flags()` field.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`malloc()`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated with `memAlloc`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`malloc(int capacity)`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance allocated with `memAlloc`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated on the specified `MemoryStack`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`mallocStack()`	Deprecated.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static int`	`ndiscardRectangleCount(long struct)`	Unsafe version of `discardRectangleCount()`.
`static void`	`ndiscardRectangleCount(long struct, int value)`	Sets the specified value to the `discardRectangleCount` field of the specified `struct`.
`static int`	`ndiscardRectangleMode(long struct)`	Unsafe version of `discardRectangleMode()`.
`static void`	`ndiscardRectangleMode(long struct, int value)`	Unsafe version of `discardRectangleMode`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static VkRect2D.Buffer`	`npDiscardRectangles(long struct)`	Unsafe version of `pDiscardRectangles()`.
`static void`	`npDiscardRectangles(long struct, VkRect2D.Buffer value)`	Unsafe version of `pDiscardRectangles`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`VkRect2D.Buffer`	`pDiscardRectangles()`	a pointer to an array of `VkRect2D` structures defining discard rectangles.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`pDiscardRectangles(VkRect2D.Buffer value)`	Sets the address of the specified `VkRect2D.Buffer` to the `pDiscardRectangles()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`set(int sType, long pNext, int flags, int discardRectangleMode, int discardRectangleCount, VkRect2D.Buffer pDiscardRectangles)`	Initializes this struct with the specified values.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`set(VkPipelineDiscardRectangleStateCreateInfoEXT src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`sType$Default()`	Sets the `STRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT` value to the `sType()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- STYPE, PNEXT, FLAGS, DISCARDRECTANGLEMODE, DISCARDRECTANGLECOUNT, PDISCARDRECTANGLES
  
  The struct member offsets.

Constructor Detail
- VkPipelineDiscardRectangleStateCreateInfoEXT
```
public VkPipelineDiscardRectangleStateCreateInfoEXT(java.nio.ByteBuffer container)
```
  Creates a VkPipelineDiscardRectangleStateCreateInfoEXT instance at the current position of the specified ByteBuffer 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()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

sType
```
public int sType()
```
the type of 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()
```
a VkDiscardRectangleModeEXT value determining whether the discard rectangle test is inclusive or exclusive.

discardRectangleCount
```
public int discardRectangleCount()
```
the number of discard rectangles to use.

pDiscardRectangles
```
@Nullable
public VkRect2D.Buffer pDiscardRectangles()
```
a pointer to an array of VkRect2D structures defining discard rectangles.

sType

public VkPipelineDiscardRectangleStateCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkPipelineDiscardRectangleStateCreateInfoEXT sType$Default()
```
Sets the STRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT value to the sType() field.

pNext

public VkPipelineDiscardRectangleStateCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkPipelineDiscardRectangleStateCreateInfoEXT flags(int value)

Sets the specified value to the flags() field.

discardRectangleMode

public VkPipelineDiscardRectangleStateCreateInfoEXT discardRectangleMode(int value)

Sets the specified value to the discardRectangleMode() field.

discardRectangleCount

public VkPipelineDiscardRectangleStateCreateInfoEXT discardRectangleCount(int value)

Sets the specified value to the discardRectangleCount() field.

pDiscardRectangles

public VkPipelineDiscardRectangleStateCreateInfoEXT pDiscardRectangles(@Nullable
                                                                       VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the pDiscardRectangles() 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
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT malloc()
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT calloc()
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT create()
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT instance allocated with BufferUtils.

create
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT create(long address)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineDiscardRectangleStateCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer malloc(int capacity)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer calloc(int capacity)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer create(int capacity)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer create(long address,
                                                                         int capacity)

Create a VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

@Nullable
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer createSafe(long address,
                                                                             int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineDiscardRectangleStateCreateInfoEXT mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkPipelineDiscardRectangleStateCreateInfoEXT callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkPipelineDiscardRectangleStateCreateInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkPipelineDiscardRectangleStateCreateInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(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. Use malloc(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. Use calloc(int, MemoryStack) instead.

malloc
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT instance allocated on the specified MemoryStack and 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 new VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer calloc(int capacity,
                                                                         org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

ndiscardRectangleMode
```
public static int ndiscardRectangleMode(long struct)
```
Unsafe version of discardRectangleMode().

ndiscardRectangleCount
```
public static int ndiscardRectangleCount(long struct)
```
Unsafe version of discardRectangleCount().

npDiscardRectangles

@Nullable
public static VkRect2D.Buffer npDiscardRectangles(long struct)

Unsafe version of pDiscardRectangles().

nsType

public static void nsType(long struct,
                          int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
                          long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
                          int value)

Unsafe version of flags.

ndiscardRectangleMode

public static void ndiscardRectangleMode(long struct,
                                         int value)

Unsafe version of discardRectangleMode.

ndiscardRectangleCount

public static void ndiscardRectangleCount(long struct,
                                          int value)

Sets the specified value to the discardRectangleCount field of the specified struct.

npDiscardRectangles

public static void npDiscardRectangles(long struct,
                                       @Nullable
                                       VkRect2D.Buffer value)

Unsafe version of pDiscardRectangles.

Class VkPipelineDiscardRectangleStateCreateInfoEXT

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, DISCARDRECTANGLEMODE, DISCARDRECTANGLECOUNT, PDISCARDRECTANGLES

Constructor Detail

VkPipelineDiscardRectangleStateCreateInfoEXT

Method Detail

sizeof

sType

pNext

flags

discardRectangleMode

discardRectangleCount

pDiscardRectangles

sType

sType$Default

pNext

flags

discardRectangleMode

discardRectangleCount

pDiscardRectangles

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nflags

ndiscardRectangleMode

ndiscardRectangleCount

npDiscardRectangles

nsType

npNext

nflags

ndiscardRectangleMode

ndiscardRectangleCount

npDiscardRectangles