Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCommandBufferInheritanceViewportScissorInfoNV

extends Struct<VkCommandBufferInheritanceViewportScissorInfoNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying command buffer inheritance information.
Description

If the pNext chain of VkCommandBufferInheritanceInfo includes a VkCommandBufferInheritanceViewportScissorInfoNV structure, then that structure controls whether a command buffer can inherit the following state from other command buffers:

as well as the following state, with restrictions on inherited depth values and viewport count:

If viewportScissor2D is FALSE, then the command buffer does not inherit the listed dynamic state, and should set this state itself. If this structure is not present, the behavior is as if viewportScissor2D is FALSE.

If viewportScissor2D is TRUE, then the listed dynamic state is inherited, and the command buffer must not set this state, except that the viewport and scissor count may be set by binding a graphics pipeline that does not specify this state as dynamic.

Note

Due to this restriction, applications should ensure either all or none of the graphics pipelines bound in this secondary command buffer use dynamic viewport/scissor counts.

When the command buffer is executed as part of a the execution of a CmdExecuteCommands command, the inherited state (if enabled) is determined by the following procedure, performed separately for each dynamic state, and separately for each value for dynamic state that consists of multiple values (e.g. multiple viewports).

Note

There is no support for inheriting dynamic state from a secondary command buffer executed as part of a different vkCmdExecuteCommands command.

Valid Usage
Valid Usage (Implicit)
See Also

VkViewport

Layout


struct VkCommandBufferInheritanceViewportScissorInfoNV {
    VkStructureType sType;
    void const * pNext;
    VkBool32 viewportScissor2D;
    uint32_t viewportDepthCount;
    VkViewport const * pViewportDepths;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
PVIEWPORTDEPTHS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
VIEWPORTDEPTHCOUNT

The struct member offsets.

public static final int
VIEWPORTSCISSOR2D

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkCommandBufferInheritanceViewportScissorInfoNV(ByteBuffer container)

Creates a VkCommandBufferInheritanceViewportScissorInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkCommandBufferInheritanceViewportScissorInfoNV
calloc()

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV instance allocated with memCalloc.

public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV.Buffer instance allocated with memCalloc.

public static VkCommandBufferInheritanceViewportScissorInfoNV
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkCommandBufferInheritanceViewportScissorInfoNV
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkCommandBufferInheritanceViewportScissorInfoNV
create()

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV instance allocated with BufferUtils.

public static VkCommandBufferInheritanceViewportScissorInfoNV
create(long address)

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV instance for the specified memory address.

public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV.Buffer instance allocated with BufferUtils.

public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkCommandBufferInheritanceViewportScissorInfoNV.Buffer instance at the specified memory.

public static VkCommandBufferInheritanceViewportScissorInfoNV
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkCommandBufferInheritanceViewportScissorInfoNV
malloc()

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV instance allocated with memAlloc.

public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV.Buffer instance allocated with memAlloc.

public static VkCommandBufferInheritanceViewportScissorInfoNV
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV instance allocated on the specified MemoryStack.

public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkViewport
npViewportDepths(long struct)

Unsafe version of pViewportDepths.

public static void
npViewportDepths(long struct, VkViewport value)

Unsafe version of pViewportDepths.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nviewportDepthCount(long struct)

Unsafe version of viewportDepthCount.

public static void
nviewportDepthCount(long struct, int value)

Unsafe version of viewportDepthCount.

public static int
nviewportScissor2D(long struct)

Unsafe version of viewportScissor2D.

public static void
nviewportScissor2D(long struct, int value)

Unsafe version of viewportScissor2D.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkCommandBufferInheritanceViewportScissorInfoNV
pNext(long value)

Sets the specified value to the pNext field.

public VkViewport
pViewportDepths()

a pointer to a VkViewport structure specifying the expected depth range for each inherited viewport.

public VkCommandBufferInheritanceViewportScissorInfoNV
pViewportDepths(VkViewport value)

Sets the address of the specified VkViewport to the pViewportDepths field.

public VkCommandBufferInheritanceViewportScissorInfoNV
set(int sType, long pNext, boolean viewportScissor2D, int viewportDepthCount, VkViewport pViewportDepths)

Initializes this struct with the specified values.

public VkCommandBufferInheritanceViewportScissorInfoNV

Returns:

this struct
set
(VkCommandBufferInheritanceViewportScissorInfoNV
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkCommandBufferInheritanceViewportScissorInfoNV
sType(int value)

Sets the specified value to the sType field.

public VkCommandBufferInheritanceViewportScissorInfoNV
public int
viewportDepthCount()

specifies the maximum number of viewports to inherit.

public VkCommandBufferInheritanceViewportScissorInfoNV
viewportDepthCount(int value)

Sets the specified value to the viewportDepthCount field.

public boolean
viewportScissor2D()

specifies whether the listed dynamic state is inherited.

public VkCommandBufferInheritanceViewportScissorInfoNV
viewportScissor2D(boolean value)

Sets the specified value to the viewportScissor2D field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PVIEWPORTDEPTHSback to summary
public static final int PVIEWPORTDEPTHS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

VIEWPORTDEPTHCOUNTback to summary
public static final int VIEWPORTDEPTHCOUNT

The struct member offsets.

VIEWPORTSCISSOR2Dback to summary
public static final int VIEWPORTSCISSOR2D

The struct member offsets.

Constructor Detail

VkCommandBufferInheritanceViewportScissorInfoNVback to summary
protected VkCommandBufferInheritanceViewportScissorInfoNV(long address, ByteBuffer container)
VkCommandBufferInheritanceViewportScissorInfoNVback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV(ByteBuffer container)

Creates a VkCommandBufferInheritanceViewportScissorInfoNV 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

callocback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV calloc()

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

callocback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkCommandBufferInheritanceViewportScissorInfoNV create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV create()

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV instance allocated with BufferUtils.

createback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV create(long address)

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV instance for the specified memory address.

createback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer create(int capacity)

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer create(long address, int capacity)

Create a VkCommandBufferInheritanceViewportScissorInfoNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV malloc()

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

mallocback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV malloc(MemoryStack stack)

Returns a new VkCommandBufferInheritanceViewportScissorInfoNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkCommandBufferInheritanceViewportScissorInfoNV.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npViewportDepthsback to summary
public static VkViewport npViewportDepths(long struct)

Unsafe version of pViewportDepths.

Annotations
@Nullable
npViewportDepthsback to summary
public static void npViewportDepths(long struct, VkViewport value)

Unsafe version of pViewportDepths.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

nviewportDepthCountback to summary
public static int nviewportDepthCount(long struct)

Unsafe version of viewportDepthCount.

nviewportDepthCountback to summary
public static void nviewportDepthCount(long struct, int value)

Unsafe version of viewportDepthCount.

nviewportScissor2Dback to summary
public static int nviewportScissor2D(long struct)

Unsafe version of viewportScissor2D.

nviewportScissor2Dback to summary
public static void nviewportScissor2D(long struct, int value)

Unsafe version of viewportScissor2D.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV pNext(long value)

Sets the specified value to the pNext field.

pViewportDepthsback to summary
public VkViewport pViewportDepths()

a pointer to a VkViewport structure specifying the expected depth range for each inherited viewport.

Annotations
@Nullable
@NativeType:VkViewport const *
pViewportDepthsback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV pViewportDepths(VkViewport value)

Sets the address of the specified VkViewport to the pViewportDepths field.

setback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV set(int sType, long pNext, boolean viewportScissor2D, int viewportDepthCount, VkViewport pViewportDepths)

Initializes this struct with the specified values.

setback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV set(VkCommandBufferInheritanceViewportScissorInfoNV src)

Copies the specified struct data to this struct.

Parameters
src:VkCommandBufferInheritanceViewportScissorInfoNV

the source struct

Returns:VkCommandBufferInheritanceViewportScissorInfoNV

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_VIEWPORT_SCISSOR_INFO_NV value to the sType field.

viewportDepthCountback to summary
public int viewportDepthCount()

specifies the maximum number of viewports to inherit. When viewportScissor2D is FALSE, the behavior is as if this value is zero.

Annotations
@NativeType:uint32_t
viewportDepthCountback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV viewportDepthCount(int value)

Sets the specified value to the viewportDepthCount field.

viewportScissor2Dback to summary
public boolean viewportScissor2D()

specifies whether the listed dynamic state is inherited.

Annotations
@NativeType:VkBool32
viewportScissor2Dback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV viewportScissor2D(boolean value)

Sets the specified value to the viewportScissor2D field.

org.lwjgl.vulkan back to summary

public Class VkCommandBufferInheritanceViewportScissorInfoNV.Buffer

extends StructBuffer<VkCommandBufferInheritanceViewportScissorInfoNV, VkCommandBufferInheritanceViewportScissorInfoNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkCommandBufferInheritanceViewportScissorInfoNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkCommandBufferInheritanceViewportScissorInfoNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCommandBufferInheritanceViewportScissorInfoNV.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkCommandBufferInheritanceViewportScissorInfoNV
public long
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
pNext(long value)

Sets the specified value to the VkCommandBufferInheritanceViewportScissorInfoNV#pNext field.

public VkViewport

Returns:

a VkViewport view of the struct pointed to by the VkCommandBufferInheritanceViewportScissorInfoNV#pViewportDepths field.
pViewportDepths
()

public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
protected VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
public int
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
sType(int value)

Sets the specified value to the VkCommandBufferInheritanceViewportScissorInfoNV#sType field.

public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
public int
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
public boolean
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer
viewportScissor2D(boolean value)

Sets the specified value to the VkCommandBufferInheritanceViewportScissorInfoNV#viewportScissor2D field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCommandBufferInheritanceViewportScissorInfoNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCommandBufferInheritanceViewportScissorInfoNV.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkCommandBufferInheritanceViewportScissorInfoNV#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkCommandBufferInheritanceViewportScissorInfoNV getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkCommandBufferInheritanceViewportScissorInfoNV#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer pNext(long value)

Sets the specified value to the VkCommandBufferInheritanceViewportScissorInfoNV#pNext field.

pViewportDepthsback to summary
public VkViewport pViewportDepths()
Returns:VkViewport

a VkViewport view of the struct pointed to by the VkCommandBufferInheritanceViewportScissorInfoNV#pViewportDepths field.

Annotations
@Nullable
@NativeType:VkViewport const *
pViewportDepthsback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer pViewportDepths(VkViewport value)

Sets the address of the specified VkViewport to the VkCommandBufferInheritanceViewportScissorInfoNV#pViewportDepths field.

selfback to summary
protected VkCommandBufferInheritanceViewportScissorInfoNV.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkCommandBufferInheritanceViewportScissorInfoNV#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer sType(int value)

Sets the specified value to the VkCommandBufferInheritanceViewportScissorInfoNV#sType field.

sType$Defaultback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_VIEWPORT_SCISSOR_INFO_NV value to the VkCommandBufferInheritanceViewportScissorInfoNV#sType field.

viewportDepthCountback to summary
public int viewportDepthCount()
Returns:int

the value of the VkCommandBufferInheritanceViewportScissorInfoNV#viewportDepthCount field.

Annotations
@NativeType:uint32_t
viewportDepthCountback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer viewportDepthCount(int value)

Sets the specified value to the VkCommandBufferInheritanceViewportScissorInfoNV#viewportDepthCount field.

viewportScissor2Dback to summary
public boolean viewportScissor2D()
Returns:boolean

the value of the VkCommandBufferInheritanceViewportScissorInfoNV#viewportScissor2D field.

Annotations
@NativeType:VkBool32
viewportScissor2Dback to summary
public VkCommandBufferInheritanceViewportScissorInfoNV.Buffer viewportScissor2D(boolean value)

Sets the specified value to the VkCommandBufferInheritanceViewportScissorInfoNV#viewportScissor2D field.