Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCommandBufferInheritanceRenderingInfo

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

Structure specifying command buffer inheritance info for dynamic render pass instances.
Description

If the pNext chain of VkCommandBufferInheritanceInfo includes a VkCommandBufferInheritanceRenderingInfo structure, then that structure controls parameters of dynamic render pass instances that the VkCommandBuffer can be executed within. If VkCommandBufferInheritanceInfo::renderPass is not NULL_HANDLE, or COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT is not specified in VkCommandBufferBeginInfo::flags, parameters of this structure are ignored.

If colorAttachmentCount is 0 and the variableMultisampleRate feature is enabled, rasterizationSamples is ignored.

If depthAttachmentFormat, stencilAttachmentFormat, or any element of pColorAttachmentFormats is FORMAT_UNDEFINED, it indicates that the corresponding attachment is unused within the render pass and writes to those attachments are discarded.

Valid Usage
Valid Usage (Implicit)

Layout


struct VkCommandBufferInheritanceRenderingInfo {
    VkStructureType sType;
    void const * pNext;
    VkRenderingFlags flags;
    uint32_t viewMask;
    uint32_t colorAttachmentCount;
    VkFormat const * pColorAttachmentFormats;
    VkFormat depthAttachmentFormat;
    VkFormat stencilAttachmentFormat;
    VkSampleCountFlagBits rasterizationSamples;
}

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
DEPTHATTACHMENTFORMAT

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
PCOLORATTACHMENTFORMATS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
RASTERIZATIONSAMPLES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STENCILATTACHMENTFORMAT

The struct member offsets.

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
public
VkCommandBufferInheritanceRenderingInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCommandBufferInheritanceRenderingInfo
calloc()

Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated with memCalloc.

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

Returns a new VkCommandBufferInheritanceRenderingInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public int
colorAttachmentCount()

the number of color attachments specified in the render pass instance.

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

Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated with BufferUtils.

public static VkCommandBufferInheritanceRenderingInfo
create(long address)

Returns a new VkCommandBufferInheritanceRenderingInfo instance for the specified memory address.

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

Returns a new VkCommandBufferInheritanceRenderingInfo.Buffer instance allocated with BufferUtils.

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

Create a VkCommandBufferInheritanceRenderingInfo.Buffer instance at the specified memory.

public static VkCommandBufferInheritanceRenderingInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
depthAttachmentFormat()

a VkFormat value defining the format of the depth attachment.

public VkCommandBufferInheritanceRenderingInfo
depthAttachmentFormat(int value)

Sets the specified value to the depthAttachmentFormat field.

public int
flags()

a bitmask of VkRenderingFlagBits used by the render pass instance.

public VkCommandBufferInheritanceRenderingInfo
flags(int value)

Sets the specified value to the flags field.

public static VkCommandBufferInheritanceRenderingInfo
malloc()

Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated with memAlloc.

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

Returns a new VkCommandBufferInheritanceRenderingInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated on the specified MemoryStack.

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

Returns a new VkCommandBufferInheritanceRenderingInfo.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
ndepthAttachmentFormat(long struct)

Unsafe version of depthAttachmentFormat.

public static void
ndepthAttachmentFormat(long struct, int value)

Unsafe version of depthAttachmentFormat.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static IntBuffer
npColorAttachmentFormats(long struct)

Unsafe version of pColorAttachmentFormats.

public static void
npColorAttachmentFormats(long struct, IntBuffer value)

Unsafe version of pColorAttachmentFormats.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nrasterizationSamples(long struct)

Unsafe version of rasterizationSamples.

public static void
nrasterizationSamples(long struct, int value)

Unsafe version of rasterizationSamples.

public static int
nstencilAttachmentFormat(long struct)

Unsafe version of stencilAttachmentFormat.

public static void
nstencilAttachmentFormat(long struct, int value)

Unsafe version of stencilAttachmentFormat.

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 IntBuffer
pColorAttachmentFormats()

a pointer to an array of VkFormat values defining the format of color attachments.

public VkCommandBufferInheritanceRenderingInfo
pColorAttachmentFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the pColorAttachmentFormats field.

public long
pNext()

NULL or a pointer to a structure extending this structure

public VkCommandBufferInheritanceRenderingInfo
pNext(long value)

Sets the specified value to the pNext field.

public int
rasterizationSamples()

a VkSampleCountFlagBits specifying the number of samples used in rasterization.

public VkCommandBufferInheritanceRenderingInfo
rasterizationSamples(int value)

Sets the specified value to the rasterizationSamples field.

public VkCommandBufferInheritanceRenderingInfo
set(int sType, long pNext, int flags, int viewMask, IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat, int rasterizationSamples)

Initializes this struct with the specified values.

public VkCommandBufferInheritanceRenderingInfo

Returns:

this struct
set
(VkCommandBufferInheritanceRenderingInfo
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
stencilAttachmentFormat()

a VkFormat value defining the format of the stencil attachment.

public VkCommandBufferInheritanceRenderingInfo
stencilAttachmentFormat(int value)

Sets the specified value to the stencilAttachmentFormat field.

public int
sType()

a VkStructureType value identifying this structure.

public VkCommandBufferInheritanceRenderingInfo
sType(int value)

Sets the specified value to the sType field.

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

Validates pointer members that should not be NULL.

public int
viewMask()

the view mask used for rendering.

public VkCommandBufferInheritanceRenderingInfo
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