Package org.lwjgl.vulkan
Class VkPipelineViewportExclusiveScissorStateCreateInfoNV
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPipelineViewportExclusiveScissorStateCreateInfoNV>
org.lwjgl.vulkan.VkPipelineViewportExclusiveScissorStateCreateInfoNV
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkPipelineViewportExclusiveScissorStateCreateInfoNV
extends Struct<VkPipelineViewportExclusiveScissorStateCreateInfoNV>
implements NativeResource
Structure specifying parameters controlling exclusive scissor testing.
Description
If the DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV
dynamic state is enabled for a pipeline, the pExclusiveScissors
member is ignored.
When this structure is included in the pNext
chain of VkGraphicsPipelineCreateInfo
, it defines parameters of the exclusive scissor test. If this structure is not included in the pNext
chain, it is equivalent to specifying this structure with a exclusiveScissorCount
of 0.
Valid Usage
- If the
multiViewport
feature is not enabled,exclusiveScissorCount
must be 0 or 1 exclusiveScissorCount
must be less than or equal toVkPhysicalDeviceLimits
::maxViewports
exclusiveScissorCount
must be 0 or greater than or equal to theviewportCount
member ofVkPipelineViewportStateCreateInfo
Valid Usage (Implicit)
See Also
Layout
struct VkPipelineViewportExclusiveScissorStateCreateInfoNV {
VkStructureType sType()
;
void const * pNext()
;
uint32_t exclusiveScissorCount()
;
VkRect2D
const * pExclusiveScissors()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkPipelineViewportExclusiveScissorStateCreateInfoNV
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 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 aVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
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 newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance for the specified memory address.create
(long address, int capacity) Create aVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
the number of exclusive scissor rectangles.exclusiveScissorCount
(int value) Sets the specified value to theexclusiveScissorCount()
field.malloc()
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static int
nexclusiveScissorCount
(long struct) Unsafe version ofexclusiveScissorCount()
.static void
nexclusiveScissorCount
(long struct, int value) Sets the specified value to theexclusiveScissorCount
field of the specifiedstruct
.static VkRect2D.Buffer
npExclusiveScissors
(long struct) Unsafe version ofpExclusiveScissors()
.static void
npExclusiveScissors
(long struct, VkRect2D.Buffer value) Unsafe version ofpExclusiveScissors
.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 exclusive scissor rectangles.Sets the address of the specifiedVkRect2D.Buffer
to thepExclusiveScissors()
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 exclusiveScissorCount, VkRect2D.Buffer pExclusiveScissors) 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_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV
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. -
EXCLUSIVESCISSORCOUNT
public static final int EXCLUSIVESCISSORCOUNTThe struct member offsets. -
PEXCLUSIVESCISSORS
public static final int PEXCLUSIVESCISSORSThe struct member offsets.
-
-
Constructor Details
-
VkPipelineViewportExclusiveScissorStateCreateInfoNV
Creates aVkPipelineViewportExclusiveScissorStateCreateInfoNV
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<VkPipelineViewportExclusiveScissorStateCreateInfoNV>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
exclusiveScissorCount
public int exclusiveScissorCount()the number of exclusive scissor rectangles. -
pExclusiveScissors
a pointer to an array ofVkRect2D
structures defining exclusive scissor rectangles. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
exclusiveScissorCount
Sets the specified value to theexclusiveScissorCount()
field. -
pExclusiveScissors
public VkPipelineViewportExclusiveScissorStateCreateInfoNV pExclusiveScissors(@Nullable VkRect2D.Buffer value) Sets the address of the specifiedVkRect2D.Buffer
to thepExclusiveScissors()
field. -
set
public VkPipelineViewportExclusiveScissorStateCreateInfoNV set(int sType, long pNext, int exclusiveScissorCount, @Nullable VkRect2D.Buffer pExclusiveScissors) Initializes this struct with the specified values. -
set
public VkPipelineViewportExclusiveScissorStateCreateInfoNV set(VkPipelineViewportExclusiveScissorStateCreateInfoNV src) Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated withBufferUtils
. -
create
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance for the specified memory address. -
createSafe
@Nullable public static VkPipelineViewportExclusiveScissorStateCreateInfoNV createSafe(long address) -
malloc
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer create(long address, int capacity) Create aVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.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 VkPipelineViewportExclusiveScissorStateCreateInfoNV mallocStack(MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
@Deprecated public static VkPipelineViewportExclusiveScissorStateCreateInfoNV callocStack(MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
@Deprecated public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer mallocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer callocStack(int capacity) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer malloc(int capacity, MemoryStack stack) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer calloc(int capacity, MemoryStack stack) Returns a newVkPipelineViewportExclusiveScissorStateCreateInfoNV.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()
. -
nexclusiveScissorCount
public static int nexclusiveScissorCount(long struct) Unsafe version ofexclusiveScissorCount()
. -
npExclusiveScissors
Unsafe version ofpExclusiveScissors()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nexclusiveScissorCount
public static void nexclusiveScissorCount(long struct, int value) Sets the specified value to theexclusiveScissorCount
field of the specifiedstruct
. -
npExclusiveScissors
Unsafe version ofpExclusiveScissors
.
-