VkPipelineDiscardRectangleStateCreateInfoEXT (LWJGL 3.2.4 SNAPSHOT

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.
Valid Usage
- discardRectangleCount must be between 0 and VkPhysicalDeviceDiscardRectanglePropertiesEXT::maxDiscardRectangles, inclusive
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

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – reserved for future use.
- discardRectangleMode – the mode used to determine whether fragments that lie within the discard rectangle are discarded or not.
- discardRectangleCount – the number of discard rectangles used by the pipeline.
- pDiscardRectangles – a pointer to an array of VkRect2D structures, defining the discard rectangles. If the discard rectangle state is dynamic, this member is ignored.
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 and 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
Modifier and Type	Class and Description
`static class`	`VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` An array of `VkPipelineDiscardRectangleStateCreateInfoEXT` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DISCARDRECTANGLECOUNT` The struct member offsets.
`static int`	`DISCARDRECTANGLEMODE` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`PDISCARDRECTANGLES` The struct member offsets.
`static int`	`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 and 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
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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()` Returns the value of the `discardRectangleCount` field.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`discardRectangleCount(int value)` Sets the specified value to the `discardRectangleCount` field.
`int`	`discardRectangleMode()` Returns the value of the `discardRectangleMode` field.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`discardRectangleMode(int value)` Sets the specified value to the `discardRectangleMode` field.
`int`	`flags()` Returns the value of the `flags` field.
`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`	`mallocStack()` Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineDiscardRectangleStateCreateInfoEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineDiscardRectangleStateCreateInfoEXT` instance allocated on the specified `MemoryStack`.
`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()` Returns a `VkRect2D.Buffer` view of the struct array pointed to by the `pDiscardRectangles` field.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`pDiscardRectangles(VkRect2D.Buffer value)` Sets the address of the specified `VkRect2D.Buffer` to the `pDiscardRectangles` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`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()` Returns the value of the `sType` field.
`VkPipelineDiscardRectangleStateCreateInfoEXT`	`sType(int value)` Sets the specified value to the `sType` field.

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

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

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

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

Field Detail
- SIZEOF
```
public static final int SIZEOF
```
  The struct size in bytes.
- ALIGNOF
```
public static final int ALIGNOF
```
  The struct alignment in bytes.
- STYPE
```
public static final int STYPE
```
  The struct member offsets.
- PNEXT
```
public static final int PNEXT
```
  The struct member offsets.
- FLAGS
```
public static final int FLAGS
```
  The struct member offsets.
- DISCARDRECTANGLEMODE
```
public static final int DISCARDRECTANGLEMODE
```
  The struct member offsets.
- DISCARDRECTANGLECOUNT
```
public static final int DISCARDRECTANGLECOUNT
```
  The struct member offsets.
- PDISCARDRECTANGLES
```
public static final int 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()
```
Returns the value of the sType field.

pNext
```
public long pNext()
```
Returns the value of the pNext field.

flags
```
public int flags()
```
Returns the value of the flags field.

discardRectangleMode
```
public int discardRectangleMode()
```
Returns the value of the discardRectangleMode field.

discardRectangleCount
```
public int discardRectangleCount()
```
Returns the value of the discardRectangleCount field.

pDiscardRectangles
```
@Nullable
public VkRect2D.Buffer pDiscardRectangles()
```
Returns a VkRect2D.Buffer view of the struct array pointed to by the pDiscardRectangles field.

sType

public VkPipelineDiscardRectangleStateCreateInfoEXT sType(int value)

Sets the specified 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
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT mallocStack()
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT instance allocated on the thread-local MemoryStack.

callocStack
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT callocStack()
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

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

Parameters:

stack - the stack from which to allocate

callocStack
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT callocStack(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

mallocStack
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer mallocStack(int capacity)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer callocStack(int capacity)
```
Returns a new VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

mallocStack

public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer mallocStack(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

callocStack
```
public static VkPipelineDiscardRectangleStateCreateInfoEXT.Buffer callocStack(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

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

DISCARDRECTANGLEMODE

DISCARDRECTANGLECOUNT

PDISCARDRECTANGLES

Constructor Detail

VkPipelineDiscardRectangleStateCreateInfoEXT

Method Detail

sizeof

sType

pNext

flags

discardRectangleMode

discardRectangleCount

pDiscardRectangles

sType

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

nsType

npNext

nflags

ndiscardRectangleMode

ndiscardRectangleCount

npDiscardRectangles

nsType

npNext

nflags

ndiscardRectangleMode

ndiscardRectangleCount

npDiscardRectangles