Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM

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

Set the multiview per view render areas for a render pass instance.
Description

If perViewRenderAreaCount is not zero, then the elements of pPerViewRenderAreas override the value of VkRenderPassBeginInfo::renderArea or VkRenderingInfo::renderArea and define per-view render areas for the individual views of a multiview render pass. The render area for the view with view index i is specified by pPerViewRenderAreas[i].

The per-view render areas define per-view regions of attachments that are loaded, stored, and resolved according to the loadOp, storeOp, and resolveMode values of the render pass instance. When per-view render areas are defined, the value of VkRenderPassBeginInfo::renderArea or VkRenderingInfo::renderArea must be set to a render area that includes the union of all per-view render areas, may be used by the implementation for optimizations, but does not affect loads, stores, or resolves.

If this structure is present and if perViewRenderAreaCount is not zero, then perViewRenderAreaCount must be at least least one greater than the most significant bit set in any any element of VkRenderPassMultiviewCreateInfo::pViewMasks. or VkRenderingInfo::viewMask

If this structure is not present or if perViewRenderAreaCount is zero, VkRenderPassBeginInfo::renderArea or VkRenderingInfo::renderArea is used for all views.

Valid Usage
Valid Usage (Implicit)
See Also

VkRect2D

Layout


struct VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM {
    VkStructureType sType;
    void const * pNext;
    uint32_t perViewRenderAreaCount;
    VkRect2D const * pPerViewRenderAreas;
}

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
PERVIEWRENDERAREACOUNT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PPERVIEWRENDERAREAS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
calloc()

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM instance allocated with memCalloc.

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

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
create()

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM instance allocated with BufferUtils.

public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
create(long address)

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM instance for the specified memory address.

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

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer instance allocated with BufferUtils.

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

Create a VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer instance at the specified memory.

public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
malloc()

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM instance allocated with memAlloc.

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

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer instance allocated with memAlloc.

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

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM instance allocated on the specified MemoryStack.

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

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

public static int
nperViewRenderAreaCount(long struct)

Unsafe version of perViewRenderAreaCount.

public static void
nperViewRenderAreaCount(long struct, int value)

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkRect2D.Buffer
npPerViewRenderAreas(long struct)

Unsafe version of pPerViewRenderAreas.

public static void
npPerViewRenderAreas(long struct, VkRect2D.Buffer value)

Unsafe version of pPerViewRenderAreas.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public int
perViewRenderAreaCount()

the number of elements in the pPerViewRenderAreas array.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
pNext(long value)

Sets the specified value to the pNext field.

public VkRect2D.Buffer
pPerViewRenderAreas()

a pointer to an array of VkRect2D structures defining the render area for each view.

public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
pPerViewRenderAreas(VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the pPerViewRenderAreas field.

public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
set(int sType, long pNext, VkRect2D.Buffer pPerViewRenderAreas)

Initializes this struct with the specified values.

public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM

Returns:

this struct
set
(VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
sType(int value)

Sets the specified value to the sType field.

public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

PERVIEWRENDERAREACOUNTback to summary
public static final int PERVIEWRENDERAREACOUNT

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PPERVIEWRENDERAREASback to summary
public static final int PPERVIEWRENDERAREAS

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.

Constructor Detail

VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMback to summary
protected VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM(long address, ByteBuffer container)
VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMback to summary
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM(ByteBuffer container)

Creates a VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM 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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM calloc(MemoryStack stack)

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM 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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM 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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM create()

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM instance allocated with BufferUtils.

createback to summary
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM create(long address)

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM instance for the specified memory address.

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

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM malloc(MemoryStack stack)

Returns a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nperViewRenderAreaCountback to summary
public static int nperViewRenderAreaCount(long struct)

Unsafe version of perViewRenderAreaCount.

nperViewRenderAreaCountback to summary
public static void nperViewRenderAreaCount(long struct, int value)

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

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.

npPerViewRenderAreasback to summary
public static VkRect2D.Buffer npPerViewRenderAreas(long struct)

Unsafe version of pPerViewRenderAreas.

Annotations
@Nullable
npPerViewRenderAreasback to summary
public static void npPerViewRenderAreas(long struct, VkRect2D.Buffer value)

Unsafe version of pPerViewRenderAreas.

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.

perViewRenderAreaCountback to summary
public int perViewRenderAreaCount()

the number of elements in the pPerViewRenderAreas array.

Annotations
@NativeType:uint32_t
pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pPerViewRenderAreasback to summary
public VkRect2D.Buffer pPerViewRenderAreas()

a pointer to an array of VkRect2D structures defining the render area for each view.

Annotations
@Nullable
@NativeType:VkRect2D const *
pPerViewRenderAreasback to summary
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM pPerViewRenderAreas(VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the pPerViewRenderAreas field.

setback to summary
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM set(int sType, long pNext, VkRect2D.Buffer pPerViewRenderAreas)

Initializes this struct with the specified values.

setback to summary
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM set(VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM src)

Copies the specified struct data to this struct.

Parameters
src:VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM

the source struct

Returns:VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM

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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_MULTIVIEW_PER_VIEW_RENDER_AREAS_RENDER_PASS_BEGIN_INFO_QCOM value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer

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

An array of VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM structs.

Field Summary

Modifier and TypeField and Description
private static final VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
public int
public long
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer
pNext(long value)

Sets the specified value to the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#pNext field.

public VkRect2D.Buffer
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer
protected VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer
public int
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer
sType(int value)

Sets the specified value to the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#sType field.

public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#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 VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM getElementFactory()

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

Annotations
@Override
perViewRenderAreaCountback to summary
public int perViewRenderAreaCount()
Returns:int

the value of the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#perViewRenderAreaCount field.

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

the value of the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#pNext field.

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

Sets the specified value to the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#pNext field.

pPerViewRenderAreasback to summary
public VkRect2D.Buffer pPerViewRenderAreas()
Returns:VkRect2D.Buffer

a VkRect2D.Buffer view of the struct array pointed to by the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#pPerViewRenderAreas field.

Annotations
@Nullable
@NativeType:VkRect2D const *
pPerViewRenderAreasback to summary
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer pPerViewRenderAreas(VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#pPerViewRenderAreas field.

selfback to summary
protected VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer self()

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

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

the value of the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#sType field.

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

Sets the specified value to the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#sType field.

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

Sets the STRUCTURE_TYPE_MULTIVIEW_PER_VIEW_RENDER_AREAS_RENDER_PASS_BEGIN_INFO_QCOM value to the VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM#sType field.