java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkCommandBufferInheritanceRenderingInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkCommandBufferInheritanceRenderingInfoKHR
```
public class VkCommandBufferInheritanceRenderingInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
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.

Valid Usage
- If colorAttachmentCount is not 0, rasterizationSamples must be a valid VkSampleCountFlagBits value
- If the variableMultisampleRate feature is not enabled, rasterizationSamples must be a valid VkSampleCountFlagBits value
- If any element of pColorAttachmentFormats is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
- If depthAttachmentFormat is not FORMAT_UNDEFINED, it must be a format that includes a depth aspect
- If depthAttachmentFormat is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
- When rendering to a Linear Color attachment, if any element of pColorAttachmentFormats is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV
- If stencilAttachmentFormat is not FORMAT_UNDEFINED, it must be a format that includes a stencil aspect
- If stencilAttachmentFormat is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
- If depthAttachmentFormat is not FORMAT_UNDEFINED and stencilAttachmentFormat is not FORMAT_UNDEFINED, depthAttachmentFormat must equal stencilAttachmentFormat
- If the multiview feature is not enabled, viewMask must be 0
- The index of the most significant bit in viewMask must be less than maxMultiviewViewCount
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_RENDERING_INFO
- flags must be a valid combination of VkRenderingFlagBits values
- If colorAttachmentCount is not 0, pColorAttachmentFormats must be a valid pointer to an array of colorAttachmentCount valid VkFormat values
- depthAttachmentFormat must be a valid VkFormat value
- stencilAttachmentFormat must be a valid VkFormat value
- If rasterizationSamples is not 0, rasterizationSamples must be a valid VkSampleCountFlagBits value
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 Class Summary

Nested Classes
Modifier and Type Class Description

static class VkCommandBufferInheritanceRenderingInfo.Buffer
An array of VkCommandBufferInheritanceRenderingInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`COLORATTACHMENTCOUNT DEPTHATTACHMENTFORMAT FLAGS PCOLORATTACHMENTFORMATS PNEXT RASTERIZATIONSAMPLES`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STENCILATTACHMENTFORMAT STYPE VIEWMASK`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkCommandBufferInheritanceRenderingInfo(java.nio.ByteBuffer container)`	Creates a `VkCommandBufferInheritanceRenderingInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VkCommandBufferInheritanceRenderingInfo`	`calloc()`	Returns a new `VkCommandBufferInheritanceRenderingInfo` instance allocated with `memCalloc`.
`static VkCommandBufferInheritanceRenderingInfo.Buffer`	`calloc(int capacity)`	Returns a new `VkCommandBufferInheritanceRenderingInfo.Buffer` instance allocated with `memCalloc`.
`static VkCommandBufferInheritanceRenderingInfo.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCommandBufferInheritanceRenderingInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferInheritanceRenderingInfo`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCommandBufferInheritanceRenderingInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`colorAttachmentCount()`	the number of color attachments specified in the render pass instance.
`static VkCommandBufferInheritanceRenderingInfo`	`create()`	Returns a new `VkCommandBufferInheritanceRenderingInfo` instance allocated with `BufferUtils`.
`static VkCommandBufferInheritanceRenderingInfo.Buffer`	`create(int capacity)`	Returns a new `VkCommandBufferInheritanceRenderingInfo.Buffer` instance allocated with `BufferUtils`.
`static VkCommandBufferInheritanceRenderingInfo`	`create(long address)`	Returns a new `VkCommandBufferInheritanceRenderingInfo` instance for the specified memory address.
`static VkCommandBufferInheritanceRenderingInfo.Buffer`	`create(long address, int capacity)`	Create a `VkCommandBufferInheritanceRenderingInfo.Buffer` instance at the specified memory.
`static VkCommandBufferInheritanceRenderingInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkCommandBufferInheritanceRenderingInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`depthAttachmentFormat()`	a `VkFormat` value defining the format of the depth attachment.
`VkCommandBufferInheritanceRenderingInfo`	`depthAttachmentFormat(int value)`	Sets the specified value to the `depthAttachmentFormat()` field.
`int`	`flags()`	a bitmask of `VkRenderingFlagBits` used by the render pass instance.
`VkCommandBufferInheritanceRenderingInfo`	`flags(int value)`	Sets the specified value to the `flags()` field.
`static VkCommandBufferInheritanceRenderingInfo`	`malloc()`	Returns a new `VkCommandBufferInheritanceRenderingInfo` instance allocated with `memAlloc`.
`static VkCommandBufferInheritanceRenderingInfo.Buffer`	`malloc(int capacity)`	Returns a new `VkCommandBufferInheritanceRenderingInfo.Buffer` instance allocated with `memAlloc`.
`static VkCommandBufferInheritanceRenderingInfo.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCommandBufferInheritanceRenderingInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCommandBufferInheritanceRenderingInfo`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkCommandBufferInheritanceRenderingInfo` instance allocated on the specified `MemoryStack`.
`static int`	`ncolorAttachmentCount(long struct)`	Unsafe version of `colorAttachmentCount()`.
`static void`	`ncolorAttachmentCount(long struct, int value)`	Sets the specified value to the `colorAttachmentCount` field of the specified `struct`.
`static int`	`ndepthAttachmentFormat(long struct)`	Unsafe version of `depthAttachmentFormat()`.
`static void`	`ndepthAttachmentFormat(long struct, int value)`	Unsafe version of `depthAttachmentFormat`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static java.nio.IntBuffer`	`npColorAttachmentFormats(long struct)`	Unsafe version of `pColorAttachmentFormats`.
`static void`	`npColorAttachmentFormats(long struct, java.nio.IntBuffer value)`	Unsafe version of `pColorAttachmentFormats`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nrasterizationSamples(long struct)`	Unsafe version of `rasterizationSamples()`.
`static void`	`nrasterizationSamples(long struct, int value)`	Unsafe version of `rasterizationSamples`.
`static int`	`nstencilAttachmentFormat(long struct)`	Unsafe version of `stencilAttachmentFormat()`.
`static void`	`nstencilAttachmentFormat(long struct, int value)`	Unsafe version of `stencilAttachmentFormat`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static int`	`nviewMask(long struct)`	Unsafe version of `viewMask()`.
`static void`	`nviewMask(long struct, int value)`	Unsafe version of `viewMask`.
`java.nio.IntBuffer`	`pColorAttachmentFormats()`	a pointer to an array of `VkFormat` values defining the format of color attachments.
`VkCommandBufferInheritanceRenderingInfo`	`pColorAttachmentFormats(java.nio.IntBuffer value)`	Sets the address of the specified `IntBuffer` to the `pColorAttachmentFormats()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure
`VkCommandBufferInheritanceRenderingInfo`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`int`	`rasterizationSamples()`	a `VkSampleCountFlagBits` specifying the number of samples used in rasterization.
`VkCommandBufferInheritanceRenderingInfo`	`rasterizationSamples(int value)`	Sets the specified value to the `rasterizationSamples()` field.
`VkCommandBufferInheritanceRenderingInfo`	`set(int sType, long pNext, int flags, int viewMask, java.nio.IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat, int rasterizationSamples)`	Initializes this struct with the specified values.
`VkCommandBufferInheritanceRenderingInfo`	`set(VkCommandBufferInheritanceRenderingInfo src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stencilAttachmentFormat()`	a `VkFormat` value defining the format of the stencil attachment.
`VkCommandBufferInheritanceRenderingInfo`	`stencilAttachmentFormat(int value)`	Sets the specified value to the `stencilAttachmentFormat()` field.
`int`	`sType()`	the type of this structure
`VkCommandBufferInheritanceRenderingInfo`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkCommandBufferInheritanceRenderingInfo`	`sType$Default()`	Sets the `STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_RENDERING_INFO` value to the `sType()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.
`int`	`viewMask()`	the view mask used for rendering.
`VkCommandBufferInheritanceRenderingInfo`	`viewMask(int value)`	Sets the specified value to the `viewMask()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- STYPE, PNEXT, FLAGS, VIEWMASK, COLORATTACHMENTCOUNT, PCOLORATTACHMENTFORMATS, DEPTHATTACHMENTFORMAT, STENCILATTACHMENTFORMAT, RASTERIZATIONSAMPLES
  
  The struct member offsets.

Constructor Detail
- VkCommandBufferInheritanceRenderingInfo
```
public VkCommandBufferInheritanceRenderingInfo(java.nio.ByteBuffer container)
```
  Creates a VkCommandBufferInheritanceRenderingInfo 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

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

sType
```
public int sType()
```
the type of this structure

pNext
```
public long pNext()
```
NULL or a pointer to a structure extending this structure

flags
```
public int flags()
```
a bitmask of VkRenderingFlagBits used by the render pass instance.

viewMask
```
public int viewMask()
```
the view mask used for rendering.

colorAttachmentCount
```
public int colorAttachmentCount()
```
the number of color attachments specified in the render pass instance.

pColorAttachmentFormats
```
@Nullable
public java.nio.IntBuffer pColorAttachmentFormats()
```
a pointer to an array of VkFormat values defining the format of color attachments.

depthAttachmentFormat
```
public int depthAttachmentFormat()
```
a VkFormat value defining the format of the depth attachment.

stencilAttachmentFormat
```
public int stencilAttachmentFormat()
```
a VkFormat value defining the format of the stencil attachment.

rasterizationSamples
```
public int rasterizationSamples()
```
a VkSampleCountFlagBits specifying the number of samples used in rasterization.

sType

public VkCommandBufferInheritanceRenderingInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkCommandBufferInheritanceRenderingInfo sType$Default()
```
Sets the STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_RENDERING_INFO value to the sType() field.

pNext

public VkCommandBufferInheritanceRenderingInfo pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkCommandBufferInheritanceRenderingInfo flags(int value)

Sets the specified value to the flags() field.

viewMask

public VkCommandBufferInheritanceRenderingInfo viewMask(int value)

Sets the specified value to the viewMask() field.

pColorAttachmentFormats

public VkCommandBufferInheritanceRenderingInfo pColorAttachmentFormats(@Nullable
                                                                       java.nio.IntBuffer value)

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

depthAttachmentFormat

public VkCommandBufferInheritanceRenderingInfo depthAttachmentFormat(int value)

Sets the specified value to the depthAttachmentFormat() field.

stencilAttachmentFormat

public VkCommandBufferInheritanceRenderingInfo stencilAttachmentFormat(int value)

Sets the specified value to the stencilAttachmentFormat() field.

rasterizationSamples

public VkCommandBufferInheritanceRenderingInfo rasterizationSamples(int value)

Sets the specified value to the rasterizationSamples() field.

set

public VkCommandBufferInheritanceRenderingInfo set(int sType,
                                                   long pNext,
                                                   int flags,
                                                   int viewMask,
                                                   @Nullable
                                                   java.nio.IntBuffer pColorAttachmentFormats,
                                                   int depthAttachmentFormat,
                                                   int stencilAttachmentFormat,
                                                   int rasterizationSamples)

Initializes this struct with the specified values.

set

public VkCommandBufferInheritanceRenderingInfo set(VkCommandBufferInheritanceRenderingInfo src)

Copies the specified struct data to this struct.

Parameters:: src - the source struct
Returns:: this struct

malloc
```
public static VkCommandBufferInheritanceRenderingInfo malloc()
```
Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkCommandBufferInheritanceRenderingInfo calloc()
```
Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkCommandBufferInheritanceRenderingInfo create()
```
Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated with BufferUtils.

create
```
public static VkCommandBufferInheritanceRenderingInfo create(long address)
```
Returns a new VkCommandBufferInheritanceRenderingInfo instance for the specified memory address.

createSafe

@Nullable
public static VkCommandBufferInheritanceRenderingInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkCommandBufferInheritanceRenderingInfo.Buffer malloc(int capacity)
```
Returns a new VkCommandBufferInheritanceRenderingInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkCommandBufferInheritanceRenderingInfo.Buffer calloc(int capacity)
```
Returns a new VkCommandBufferInheritanceRenderingInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkCommandBufferInheritanceRenderingInfo.Buffer create(int capacity)
```
Returns a new VkCommandBufferInheritanceRenderingInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCommandBufferInheritanceRenderingInfo.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc
```
public static VkCommandBufferInheritanceRenderingInfo malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkCommandBufferInheritanceRenderingInfo calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkCommandBufferInheritanceRenderingInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkCommandBufferInheritanceRenderingInfo.Buffer malloc(int capacity,
                                                                    org.lwjgl.system.MemoryStack stack)

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

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkCommandBufferInheritanceRenderingInfo.Buffer calloc(int capacity,
                                                                    org.lwjgl.system.MemoryStack stack)
```
Returns a new VkCommandBufferInheritanceRenderingInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nviewMask

public static int nviewMask(long struct)

Unsafe version of viewMask().

ncolorAttachmentCount
```
public static int ncolorAttachmentCount(long struct)
```
Unsafe version of colorAttachmentCount().

npColorAttachmentFormats

@Nullable
public static java.nio.IntBuffer npColorAttachmentFormats(long struct)

Unsafe version of pColorAttachmentFormats.

ndepthAttachmentFormat
```
public static int ndepthAttachmentFormat(long struct)
```
Unsafe version of depthAttachmentFormat().

nstencilAttachmentFormat
```
public static int nstencilAttachmentFormat(long struct)
```
Unsafe version of stencilAttachmentFormat().

nrasterizationSamples
```
public static int nrasterizationSamples(long struct)
```
Unsafe version of rasterizationSamples().

nsType

public static void nsType(long struct,
                          int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
                          long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
                          int value)

Unsafe version of flags.

nviewMask

public static void nviewMask(long struct,
                             int value)

Unsafe version of viewMask.

ncolorAttachmentCount

public static void ncolorAttachmentCount(long struct,
                                         int value)

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

npColorAttachmentFormats

public static void npColorAttachmentFormats(long struct,
                                            @Nullable
                                            java.nio.IntBuffer value)

Unsafe version of pColorAttachmentFormats.

ndepthAttachmentFormat

public static void ndepthAttachmentFormat(long struct,
                                          int value)

Unsafe version of depthAttachmentFormat.

nstencilAttachmentFormat

public static void nstencilAttachmentFormat(long struct,
                                            int value)

Unsafe version of stencilAttachmentFormat.

nrasterizationSamples

public static void nrasterizationSamples(long struct,
                                         int value)

Unsafe version of rasterizationSamples.

validate
```
public static void validate(long struct)
```
Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate

Class VkCommandBufferInheritanceRenderingInfo

Description

Valid Usage

Valid Usage (Implicit)

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, VIEWMASK, COLORATTACHMENTCOUNT, PCOLORATTACHMENTFORMATS, DEPTHATTACHMENTFORMAT, STENCILATTACHMENTFORMAT, RASTERIZATIONSAMPLES

Constructor Detail

VkCommandBufferInheritanceRenderingInfo

Method Detail

sizeof

sType

pNext

flags

viewMask

colorAttachmentCount

pColorAttachmentFormats

depthAttachmentFormat

stencilAttachmentFormat

rasterizationSamples

sType

sType$Default

pNext

flags

viewMask

pColorAttachmentFormats

depthAttachmentFormat

stencilAttachmentFormat

rasterizationSamples

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nflags

nviewMask

ncolorAttachmentCount

npColorAttachmentFormats

ndepthAttachmentFormat

nstencilAttachmentFormat

nrasterizationSamples

nsType

npNext

nflags

nviewMask

ncolorAttachmentCount

npColorAttachmentFormats

ndepthAttachmentFormat

nstencilAttachmentFormat

nrasterizationSamples

validate