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, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPipelineViewportExclusiveScissorStateCreateInfoNV
extends org.lwjgl.system.Struct<VkPipelineViewportExclusiveScissorStateCreateInfoNV>
implements org.lwjgl.system.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 an 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 to VkPhysicalDeviceLimits::maxViewports
• exclusiveScissorCount must be 0 or greater than or equal to the viewportCount member of VkPipelineViewportStateCreateInfo

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV

See Also

VkRect2D

Layout

 struct VkPipelineViewportExclusiveScissorStateCreateInfoNV {
     VkStructureType sType();
     void const * pNext();
     uint32_t exclusiveScissorCount();
     VkRect2D const * pExclusiveScissors();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	An array of VkPipelineViewportExclusiveScissorStateCreateInfoNV structs.

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EXCLUSIVESCISSORCOUNT	The struct member offsets.
static final int	PEXCLUSIVESCISSORS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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
VkPipelineViewportExclusiveScissorStateCreateInfoNV(ByteBuffer container)	Creates a VkPipelineViewportExclusiveScissorStateCreateInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	calloc()	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated with memCalloc.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	calloc(int capacity)	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated with memCalloc.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	callocStack()	Deprecated.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	create()	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated with BufferUtils.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	create(int capacity)	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated with BufferUtils.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	create(long address)	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance for the specified memory address.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	create(long address, int capacity)	Create a VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance at the specified memory.
static @Nullable VkPipelineViewportExclusiveScissorStateCreateInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	exclusiveScissorCount()	the number of exclusive scissor rectangles.
VkPipelineViewportExclusiveScissorStateCreateInfoNV	exclusiveScissorCount(int value)	Sets the specified value to the exclusiveScissorCount() field.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	malloc()	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated with memAlloc.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	malloc(int capacity)	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated with memAlloc.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated on the specified MemoryStack.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	mallocStack()	Deprecated.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineViewportExclusiveScissorStateCreateInfoNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nexclusiveScissorCount(long struct)	Unsafe version of exclusiveScissorCount().
static void	nexclusiveScissorCount(long struct, int value)	Sets the specified value to the exclusiveScissorCount field of the specified struct.
static @Nullable VkRect2D.Buffer	npExclusiveScissors(long struct)	Unsafe version of pExclusiveScissors().
static void	npExclusiveScissors(long struct, @Nullable VkRect2D.Buffer value)	Unsafe version of pExclusiveScissors.
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.
@Nullable VkRect2D.Buffer	pExclusiveScissors()	a pointer to an array of VkRect2D structures defining exclusive scissor rectangles.
VkPipelineViewportExclusiveScissorStateCreateInfoNV	pExclusiveScissors(@Nullable VkRect2D.Buffer value)	Sets the address of the specified VkRect2D.Buffer to the pExclusiveScissors() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineViewportExclusiveScissorStateCreateInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineViewportExclusiveScissorStateCreateInfoNV	set(int sType, long pNext, int exclusiveScissorCount, @Nullable VkRect2D.Buffer pExclusiveScissors)	Initializes this struct with the specified values.
VkPipelineViewportExclusiveScissorStateCreateInfoNV	set(VkPipelineViewportExclusiveScissorStateCreateInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineViewportExclusiveScissorStateCreateInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkPipelineViewportExclusiveScissorStateCreateInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

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.

EXCLUSIVESCISSORCOUNT

public static final int EXCLUSIVESCISSORCOUNT

The struct member offsets.

PEXCLUSIVESCISSORS

public static final int PEXCLUSIVESCISSORS

The struct member offsets.

Constructor Details

VkPipelineViewportExclusiveScissorStateCreateInfoNV

public VkPipelineViewportExclusiveScissorStateCreateInfoNV(ByteBuffer container)

Creates a VkPipelineViewportExclusiveScissorStateCreateInfoNV 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPipelineViewportExclusiveScissorStateCreateInfoNV>

sType

public int sType()

a VkStructureType 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

public @Nullable VkRect2D.Buffer pExclusiveScissors()

a pointer to an array of VkRect2D structures defining exclusive scissor rectangles.

sType

public VkPipelineViewportExclusiveScissorStateCreateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineViewportExclusiveScissorStateCreateInfoNV sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV value to the sType() field.

pNext

public VkPipelineViewportExclusiveScissorStateCreateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

exclusiveScissorCount

public VkPipelineViewportExclusiveScissorStateCreateInfoNV exclusiveScissorCount(int value)

Sets the specified value to the exclusiveScissorCount() field.

pExclusiveScissors

public VkPipelineViewportExclusiveScissorStateCreateInfoNV pExclusiveScissors(@Nullable VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the pExclusiveScissors() 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

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV malloc()

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV calloc()

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV create()

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated with BufferUtils.

create

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV create(long address)

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkPipelineViewportExclusiveScissorStateCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer malloc(int capacity)

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer calloc(int capacity)

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer create(int capacity)

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineViewportExclusiveScissorStateCreateInfoNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineViewportExclusiveScissorStateCreateInfoNV callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.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 VkPipelineViewportExclusiveScissorStateCreateInfoNV.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 VkPipelineViewportExclusiveScissorStateCreateInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineViewportExclusiveScissorStateCreateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nexclusiveScissorCount

public static int nexclusiveScissorCount(long struct)

Unsafe version of exclusiveScissorCount().

npExclusiveScissors

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

Unsafe version of pExclusiveScissors().

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.

nexclusiveScissorCount

public static void nexclusiveScissorCount(long struct,
 int value)

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

npExclusiveScissors

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

Unsafe version of pExclusiveScissors.