Class VkPipelineRenderingCreateInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkPipelineRenderingCreateInfoKHR
Description
When a pipeline is created without a VkRenderPass, if the pNext chain of VkGraphicsPipelineCreateInfo includes this structure, it specifies the view mask and format of attachments used for rendering. If this structure is not specified, and the pipeline does not include a VkRenderPass, viewMask and colorAttachmentCount are 0, and depthAttachmentFormat and stencilAttachmentFormat are FORMAT_UNDEFINED. If a graphics pipeline is created with a valid VkRenderPass, parameters of this structure are 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 formats indicate that an attachment can be used - but it is still valid to set the attachment to NULL when beginning rendering.
If the render pass is going to be used with an external format resolve attachment, a VkExternalFormatANDROID structure must also be included in the pNext chain of VkGraphicsPipelineCreateInfo, defining the external format of the resolve attachment that will be used.
Valid Usage
colorAttachmentCountmust be less than or equal tomaxColorAttachments
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO
Layout
struct VkPipelineRenderingCreateInfo {
VkStructureType sType();
void const * pNext();
uint32_t viewMask();
uint32_t colorAttachmentCount();
VkFormat const * pColorAttachmentFormats();
VkFormat depthAttachmentFormat();
VkFormat stencilAttachmentFormat();
}-
Nested Class Summary
Nested ClassesNested 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 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
ConstructorsConstructorDescriptionVkPipelineRenderingCreateInfo(ByteBuffer container) Creates aVkPipelineRenderingCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineRenderingCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineRenderingCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.intthe number of entries inpColorAttachmentFormatscolorAttachmentCount(int value) Sets the specified value to thecolorAttachmentCount()field.create()Returns a newVkPipelineRenderingCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineRenderingCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineRenderingCreateInfo.Bufferinstance at the specified memory.static @Nullable VkPipelineRenderingCreateInfocreateSafe(long address) static @Nullable VkPipelineRenderingCreateInfo.BuffercreateSafe(long address, int capacity) intaVkFormatvalue defining the format of the depth attachment used in this pipeline.depthAttachmentFormat(int value) Sets the specified value to thedepthAttachmentFormat()field.malloc()Returns a newVkPipelineRenderingCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineRenderingCreateInfoinstance 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 @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 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 used in this pipeline.pColorAttachmentFormats(@Nullable IntBuffer value) Sets the address of the specifiedIntBufferto thepColorAttachmentFormats()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int viewMask, int colorAttachmentCount, @Nullable IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intaVkFormatvalue defining the format of the stencil attachment used in this pipeline.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_PIPELINE_RENDERING_CREATE_INFOvalue to thesType()field.intviewMask()the viewMask 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. -
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.
-
-
Constructor Details
-
VkPipelineRenderingCreateInfo
Creates aVkPipelineRenderingCreateInfoinstance 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<VkPipelineRenderingCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
viewMask
public int viewMask()the viewMask used for rendering. -
colorAttachmentCount
public int colorAttachmentCount()the number of entries inpColorAttachmentFormats -
pColorAttachmentFormats
a pointer to an array ofVkFormatvalues defining the format of color attachments used in this pipeline. -
depthAttachmentFormat
public int depthAttachmentFormat()aVkFormatvalue defining the format of the depth attachment used in this pipeline. -
stencilAttachmentFormat
public int stencilAttachmentFormat()aVkFormatvalue defining the format of the stencil attachment used in this pipeline. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
viewMask
Sets the specified value to theviewMask()field. -
colorAttachmentCount
Sets the specified value to thecolorAttachmentCount()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. -
set
public VkPipelineRenderingCreateInfo set(int sType, long pNext, int viewMask, int colorAttachmentCount, @Nullable IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat) 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 newVkPipelineRenderingCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineRenderingCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineRenderingCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkPipelineRenderingCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineRenderingCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
malloc
Returns a newVkPipelineRenderingCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineRenderingCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineRenderingCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineRenderingCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineRenderingCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineRenderingCreateInfo.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(). -
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(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
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.
-