Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkRenderingInfo

extends Struct<VkRenderingInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkRenderingInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying render pass instance begin info.
Description

If viewMask is not 0, multiview is enabled.

If there is an instance of VkDeviceGroupRenderPassBeginInfo included in the pNext chain and its deviceRenderAreaCount member is not 0, then renderArea is ignored, and the render area is defined per-device by that structure.

If multiview is enabled, and the multiviewPerViewRenderAreas feature is enabled, and there is an instance of VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM included in the pNext chain with perViewRenderAreaCount not equal to 0, then the elements of VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM::pPerViewRenderAreas override renderArea and define a render area for each view. In this case, renderArea must be set to an area at least as large as the union of all the per-view render areas.

Each element of the pColorAttachments array corresponds to an output location in the shader, i.e. if the shader declares an output variable decorated with a Location value of X, then it uses the attachment provided in pColorAttachments[X]. If the imageView member of any element of pColorAttachments is NULL_HANDLE, writes to the corresponding location by a fragment are discarded.

Valid Usage
Valid Usage (Implicit)
See Also

VkRect2D, VkRenderingAttachmentInfo, CmdBeginRendering, CmdBeginRenderingKHR, GetDynamicRenderingTilePropertiesQCOM

Layout


struct VkRenderingInfo {
    VkStructureType sType;
    void const * pNext;
    VkRenderingFlags flags;
    VkRect2D renderArea;
    uint32_t layerCount;
    uint32_t viewMask;
    uint32_t colorAttachmentCount;
    VkRenderingAttachmentInfo const * pColorAttachments;
    VkRenderingAttachmentInfo const * pDepthAttachment;
    VkRenderingAttachmentInfo const * pStencilAttachment;
}

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
COLORATTACHMENTCOUNT

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
LAYERCOUNT

The struct member offsets.

public static final int
PCOLORATTACHMENTS

The struct member offsets.

public static final int
PDEPTHATTACHMENT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PSTENCILATTACHMENT

The struct member offsets.

public static final int
RENDERAREA

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
VIEWMASK

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkRenderingInfo(long address, ByteBuffer container)

public
VkRenderingInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkRenderingInfo
calloc()

Returns a new VkRenderingInfo instance allocated with memCalloc.

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

Returns a new VkRenderingInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public int
colorAttachmentCount()

the number of elements in pColorAttachments.

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

Returns a new VkRenderingInfo instance allocated with BufferUtils.

public static VkRenderingInfo
create(long address)

Returns a new VkRenderingInfo instance for the specified memory address.

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

Returns a new VkRenderingInfo.Buffer instance allocated with BufferUtils.

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

Create a VkRenderingInfo.Buffer instance at the specified memory.

public static VkRenderingInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkRenderingFlagBits.

public VkRenderingInfo
flags(int value)

Sets the specified value to the flags field.

public int
layerCount()

the number of layers rendered to in each attachment when viewMask is 0.

public VkRenderingInfo
layerCount(int value)

Sets the specified value to the layerCount field.

public static VkRenderingInfo
malloc()

Returns a new VkRenderingInfo instance allocated with memAlloc.

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

Returns a new VkRenderingInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkRenderingInfo instance allocated on the specified MemoryStack.

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

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

public static int
ncolorAttachmentCount(long struct)

Unsafe version of colorAttachmentCount.

public static void
ncolorAttachmentCount(long struct, int value)

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

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static int
nlayerCount(long struct)

Unsafe version of layerCount.

public static void
nlayerCount(long struct, int value)

Unsafe version of layerCount.

public static VkRenderingAttachmentInfo.Buffer
npColorAttachments(long struct)

Unsafe version of pColorAttachments.

public static void
public static VkRenderingAttachmentInfo
npDepthAttachment(long struct)

Unsafe version of pDepthAttachment.

public static void
npDepthAttachment(long struct, VkRenderingAttachmentInfo value)

Unsafe version of pDepthAttachment.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkRenderingAttachmentInfo
npStencilAttachment(long struct)

Unsafe version of pStencilAttachment.

public static void
public static VkRect2D
nrenderArea(long struct)

Unsafe version of renderArea.

public static void
nrenderArea(long struct, VkRect2D value)

Unsafe version of renderArea.

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
nviewMask(long struct)

Unsafe version of viewMask.

public static void
nviewMask(long struct, int value)

Unsafe version of viewMask.

public VkRenderingAttachmentInfo.Buffer
pColorAttachments()

a pointer to an array of colorAttachmentCount VkRenderingAttachmentInfo structures describing any color attachments used.

public VkRenderingInfo
public VkRenderingAttachmentInfo
pDepthAttachment()

a pointer to a VkRenderingAttachmentInfo structure describing a depth attachment.

public VkRenderingInfo
pDepthAttachment(VkRenderingAttachmentInfo value)

Sets the address of the specified VkRenderingAttachmentInfo to the pDepthAttachment field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkRenderingInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkRenderingInfo
pNext(VkDeviceGroupRenderPassBeginInfo value)

Prepends the specified VkDeviceGroupRenderPassBeginInfo value to the pNext chain.

public VkRenderingInfo
pNext(VkDeviceGroupRenderPassBeginInfoKHR value)

Prepends the specified VkDeviceGroupRenderPassBeginInfoKHR value to the pNext chain.

public VkRenderingInfo
public VkRenderingInfo
pNext(VkMultiviewPerViewAttributesInfoNVX value)

Prepends the specified VkMultiviewPerViewAttributesInfoNVX value to the pNext chain.

public VkRenderingInfo
public VkRenderingInfo
public VkRenderingInfo
public VkRenderingAttachmentInfo
pStencilAttachment()

a pointer to a VkRenderingAttachmentInfo structure describing a stencil attachment.

public VkRenderingInfo
pStencilAttachment(VkRenderingAttachmentInfo value)

Sets the address of the specified VkRenderingAttachmentInfo to the pStencilAttachment field.

public VkRect2D
renderArea()

the render area that is affected by the render pass instance.

public VkRenderingInfo
renderArea(VkRect2D value)

Copies the specified VkRect2D to the renderArea field.

public VkRenderingInfo
renderArea(Consumer<VkRect2D> consumer)

Passes the renderArea field to the specified Consumer.

public VkRenderingInfo
set(int sType, long pNext, int flags, VkRect2D renderArea, int layerCount, int viewMask, VkRenderingAttachmentInfo.Buffer pColorAttachments, VkRenderingAttachmentInfo pDepthAttachment, VkRenderingAttachmentInfo pStencilAttachment)

Initializes this struct with the specified values.

public VkRenderingInfo

Returns:

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

Sets the specified value to the sType field.

public VkRenderingInfo
sType$Default()

Sets the STRUCTURE_TYPE_RENDERING_INFO value to the sType field.

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

Validates pointer members that should not be NULL.

public int
viewMask()

the view mask indicating the indices of attachment layers that will be rendered when it is not 0.

public VkRenderingInfo
viewMask(int value)

Sets the specified value to the viewMask field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate