Class VkCommandBufferInheritanceRenderingInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkCommandBufferInheritanceRenderingInfoKHR
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
- If
colorAttachmentCountis not 0,rasterizationSamplesmust be a validVkSampleCountFlagBitsvalue - If the
variableMultisampleRatefeature is not enabled,rasterizationSamplesmust be a validVkSampleCountFlagBitsvalue - If
depthAttachmentFormatis notFORMAT_UNDEFINED, it must be a format that includes a depth component - If
depthAttachmentFormatis notFORMAT_UNDEFINED, it must be a format with potential format features that includeFORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT - If any element of
pColorAttachmentFormatsis notFORMAT_UNDEFINED, it must be a format with potential format features that includeFORMAT_FEATURE_COLOR_ATTACHMENT_BIT, orFORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NVif thelinearColorAttachmentfeature is enabled - If
stencilAttachmentFormatis notFORMAT_UNDEFINED, it must be a format that includes a stencil aspect - If
stencilAttachmentFormatis notFORMAT_UNDEFINED, it must be a format with potential format features that includeFORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT - If
depthAttachmentFormatis notFORMAT_UNDEFINEDandstencilAttachmentFormatis notFORMAT_UNDEFINED,depthAttachmentFormatmust equalstencilAttachmentFormat - If the
multiviewfeature is not enabled,viewMaskmust be 0 - The index of the most significant bit in
viewMaskmust be less thanmaxMultiviewViewCount
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_RENDERING_INFOflagsmust be a valid combination ofVkRenderingFlagBitsvalues- If
colorAttachmentCountis not 0,pColorAttachmentFormatsmust be a valid pointer to an array ofcolorAttachmentCountvalidVkFormatvalues depthAttachmentFormatmust be a validVkFormatvaluestencilAttachmentFormatmust be a validVkFormatvalue- If
rasterizationSamplesis not 0,rasterizationSamplesmust be a validVkSampleCountFlagBitsvalue
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 ClassesModifier and TypeClassDescriptionstatic classAn array ofVkCommandBufferInheritanceRenderingInfostructs.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 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.static final intThe struct member offsets.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 aVkCommandBufferInheritanceRenderingInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.intthe number of color attachments specified in the render pass instance.create()Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkCommandBufferInheritanceRenderingInfoinstance for the specified memory address.create(long address, int capacity) Create aVkCommandBufferInheritanceRenderingInfo.Bufferinstance at the specified memory.static @Nullable VkCommandBufferInheritanceRenderingInfocreateSafe(long address) static @Nullable VkCommandBufferInheritanceRenderingInfo.BuffercreateSafe(long address, int capacity) intaVkFormatvalue defining the format of the depth attachment.depthAttachmentFormat(int value) Sets the specified value to thedepthAttachmentFormat()field.intflags()a bitmask ofVkRenderingFlagBitsused by the render pass instance.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated on the specifiedMemoryStack.static intncolorAttachmentCount(long struct) Unsafe version ofcolorAttachmentCount().static voidncolorAttachmentCount(long struct, int value) Sets the specified value to thecolorAttachmentCountfield of the specifiedstruct.static intndepthAttachmentFormat(long struct) Unsafe version ofdepthAttachmentFormat().static voidndepthAttachmentFormat(long struct, int value) Unsafe version ofdepthAttachmentFormat.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static @Nullable IntBuffernpColorAttachmentFormats(long struct) Unsafe version ofpColorAttachmentFormats.static voidnpColorAttachmentFormats(long struct, @Nullable IntBuffer value) Unsafe version ofpColorAttachmentFormats.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnrasterizationSamples(long struct) Unsafe version ofrasterizationSamples().static voidnrasterizationSamples(long struct, int value) Unsafe version ofrasterizationSamples.static intnstencilAttachmentFormat(long struct) Unsafe version ofstencilAttachmentFormat().static voidnstencilAttachmentFormat(long struct, int value) Unsafe version ofstencilAttachmentFormat.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intnviewMask(long struct) Unsafe version ofviewMask().static voidnviewMask(long struct, int value) Unsafe version ofviewMask.@Nullable IntBuffera pointer to an array ofVkFormatvalues defining the format of color attachments.pColorAttachmentFormats(@Nullable IntBuffer value) Sets the address of the specifiedIntBufferto thepColorAttachmentFormats()field.longpNext()NULLor a pointer to a structure extending this structurepNext(long value) Sets the specified value to thepNext()field.intaVkSampleCountFlagBitsspecifying the number of samples used in rasterization.rasterizationSamples(int value) Sets the specified value to therasterizationSamples()field.set(int sType, long pNext, int flags, int viewMask, @Nullable IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat, int rasterizationSamples) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intaVkFormatvalue defining the format of the stencil attachment.stencilAttachmentFormat(int value) Sets the specified value to thestencilAttachmentFormat()field.intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_RENDERING_INFOvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.intviewMask()the view mask used for rendering.viewMask(int value) Sets the specified value to theviewMask()field.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. -
FLAGS
public static final int FLAGSThe struct member offsets. -
VIEWMASK
public static final int VIEWMASKThe struct member offsets. -
COLORATTACHMENTCOUNT
public static final int COLORATTACHMENTCOUNTThe struct member offsets. -
PCOLORATTACHMENTFORMATS
public static final int PCOLORATTACHMENTFORMATSThe struct member offsets. -
DEPTHATTACHMENTFORMAT
public static final int DEPTHATTACHMENTFORMATThe struct member offsets. -
STENCILATTACHMENTFORMAT
public static final int STENCILATTACHMENTFORMATThe struct member offsets. -
RASTERIZATIONSAMPLES
public static final int RASTERIZATIONSAMPLESThe struct member offsets.
-
-
Constructor Details
-
VkCommandBufferInheritanceRenderingInfo
Creates aVkCommandBufferInheritanceRenderingInfoinstance 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<VkCommandBufferInheritanceRenderingInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure -
flags
public int flags()a bitmask ofVkRenderingFlagBitsused 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
a pointer to an array ofVkFormatvalues defining the format of color attachments. -
depthAttachmentFormat
public int depthAttachmentFormat()aVkFormatvalue defining the format of the depth attachment. -
stencilAttachmentFormat
public int stencilAttachmentFormat()aVkFormatvalue defining the format of the stencil attachment. -
rasterizationSamples
public int rasterizationSamples()aVkSampleCountFlagBitsspecifying the number of samples used in rasterization. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_RENDERING_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
viewMask
Sets the specified value to theviewMask()field. -
pColorAttachmentFormats
Sets the address of the specifiedIntBufferto thepColorAttachmentFormats()field. -
depthAttachmentFormat
Sets the specified value to thedepthAttachmentFormat()field. -
stencilAttachmentFormat
Sets the specified value to thestencilAttachmentFormat()field. -
rasterizationSamples
Sets the specified value to therasterizationSamples()field. -
set
public VkCommandBufferInheritanceRenderingInfo set(int sType, long pNext, int flags, int viewMask, @Nullable IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat, int rasterizationSamples) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated withBufferUtils. -
create
Returns a newVkCommandBufferInheritanceRenderingInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkCommandBufferInheritanceRenderingInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkCommandBufferInheritanceRenderingInfo.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkCommandBufferInheritanceRenderingInfoinstance allocated on the specifiedMemoryStackand 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 newVkCommandBufferInheritanceRenderingInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkCommandBufferInheritanceRenderingInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceRenderingInfo.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(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
nviewMask
public static int nviewMask(long struct) Unsafe version ofviewMask(). -
ncolorAttachmentCount
public static int ncolorAttachmentCount(long struct) Unsafe version ofcolorAttachmentCount(). -
npColorAttachmentFormats
Unsafe version ofpColorAttachmentFormats. -
ndepthAttachmentFormat
public static int ndepthAttachmentFormat(long struct) Unsafe version ofdepthAttachmentFormat(). -
nstencilAttachmentFormat
public static int nstencilAttachmentFormat(long struct) Unsafe version ofstencilAttachmentFormat(). -
nrasterizationSamples
public static int nrasterizationSamples(long struct) Unsafe version ofrasterizationSamples(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
nviewMask
public static void nviewMask(long struct, int value) Unsafe version ofviewMask. -
ncolorAttachmentCount
public static void ncolorAttachmentCount(long struct, int value) Sets the specified value to thecolorAttachmentCountfield of the specifiedstruct. -
npColorAttachmentFormats
Unsafe version ofpColorAttachmentFormats. -
ndepthAttachmentFormat
public static void ndepthAttachmentFormat(long struct, int value) Unsafe version ofdepthAttachmentFormat. -
nstencilAttachmentFormat
public static void nstencilAttachmentFormat(long struct, int value) Unsafe version ofstencilAttachmentFormat. -
nrasterizationSamples
public static void nrasterizationSamples(long struct, int value) Unsafe version ofrasterizationSamples. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-