Class VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
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 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 one greater than the most significant bit set in 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
- The
offset.xmember of any element ofpPerViewRenderAreasmust be greater than or equal to 0 - The
offset.ymember of any element ofpPerViewRenderAreasmust be greater than or equal to 0 - The sum of the
offset.xandextent.widthmembers of any element ofpPerViewRenderAreasmust be less than or equal tomaxFramebufferWidth - The sum of the
offset.yandextent.heightmembers of any element ofpPerViewRenderAreasmust be less than or equal tomaxFramebufferHeight - If this structure is in the
pNextchain ofVkRenderPassBeginInfoand if the render pass object included an element inVkRenderPassMultiviewCreateInfo::pViewMasksthat set bitn, thenperViewRenderAreaCountmust be at least equal ton+1 - If this structure is in the
pNextchain ofVkRenderingInfoand ifVkRenderingInfo::viewMaskset bitn, thenperViewRenderAreaCountmust be at least equal ton+1
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_MULTIVIEW_PER_VIEW_RENDER_AREAS_RENDER_PASS_BEGIN_INFO_QCOM- If
perViewRenderAreaCountis not 0,pPerViewRenderAreasmust be a valid pointer to an array ofperViewRenderAreaCountVkRect2Dstructures
See Also
Layout
struct VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM {
VkStructureType sType();
void const * pNext();
uint32_t perViewRenderAreaCount();
VkRect2D const * pPerViewRenderAreas();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates aVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated withBufferUtils.create(int capacity) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance for the specified memory address.create(long address, int capacity) Create aVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance at the specified memory.static @Nullable VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMcreateSafe(long address) static @Nullable VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated on the specifiedMemoryStack.static intnperViewRenderAreaCount(long struct) Unsafe version ofperViewRenderAreaCount().static voidnperViewRenderAreaCount(long struct, int value) Sets the specified value to theperViewRenderAreaCountfield of the specifiedstruct.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable VkRect2D.BuffernpPerViewRenderAreas(long struct) Unsafe version ofpPerViewRenderAreas().static voidnpPerViewRenderAreas(long struct, @Nullable VkRect2D.Buffer value) Unsafe version ofpPerViewRenderAreas.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.intthe number of elements in thepPerViewRenderAreasarray.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.@Nullable VkRect2D.Buffera pointer to an array ofVkRect2Dstructures defining the render area for each view.pPerViewRenderAreas(@Nullable VkRect2D.Buffer value) Sets the address of the specifiedVkRect2D.Bufferto thepPerViewRenderAreas()field.set(int sType, long pNext, @Nullable VkRect2D.Buffer pPerViewRenderAreas) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_MULTIVIEW_PER_VIEW_RENDER_AREAS_RENDER_PASS_BEGIN_INFO_QCOMvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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. -
PERVIEWRENDERAREACOUNT
public static final int PERVIEWRENDERAREACOUNTThe struct member offsets. -
PPERVIEWRENDERAREAS
public static final int PPERVIEWRENDERAREASThe struct member offsets.
-
-
Constructor Details
-
VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
Creates aVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
perViewRenderAreaCount
public int perViewRenderAreaCount()the number of elements in thepPerViewRenderAreasarray. -
pPerViewRenderAreas
a pointer to an array ofVkRect2Dstructures defining the render area for each view. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_MULTIVIEW_PER_VIEW_RENDER_AREAS_RENDER_PASS_BEGIN_INFO_QCOMvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pPerViewRenderAreas
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM pPerViewRenderAreas(@Nullable VkRect2D.Buffer value) Sets the address of the specifiedVkRect2D.Bufferto thepPerViewRenderAreas()field. -
set
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM set(int sType, long pNext, @Nullable VkRect2D.Buffer pPerViewRenderAreas) Initializes this struct with the specified values. -
set
public VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM set(VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM src) Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated withBufferUtils. -
create
Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance for the specified memory address. -
createSafe
public static @Nullable VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM createSafe(long address) -
malloc
Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer create(long address, int capacity) Create aVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer createSafe(long address, int capacity) -
malloc
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOMinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM.Bufferinstance allocated on the specifiedMemoryStackand 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(). -
nperViewRenderAreaCount
public static int nperViewRenderAreaCount(long struct) Unsafe version ofperViewRenderAreaCount(). -
npPerViewRenderAreas
Unsafe version ofpPerViewRenderAreas(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nperViewRenderAreaCount
public static void nperViewRenderAreaCount(long struct, int value) Sets the specified value to theperViewRenderAreaCountfield of the specifiedstruct. -
npPerViewRenderAreas
Unsafe version ofpPerViewRenderAreas. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-