Class VkRenderingAttachmentLocationInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
This structure allows applications to remap the locations of color attachments to different fragment shader output locations.
Each element of pColorAttachmentLocations set to ATTACHMENT_UNUSED will be inaccessible to this pipeline as a color attachment; no location will map to it. Each element of pColorAttachmentLocations set to any other value will map the specified location value to the color attachment specified in the render pass at the corresponding index in the pColorAttachmentLocations array. Any writes to a fragment output location that is not mapped to an attachment must be discarded.
If pColorAttachmentLocations is NULL, it is equivalent to setting each element to its index within the array.
This structure can be included in the pNext chain of a VkGraphicsPipelineCreateInfo structure to set this state for a pipeline. If this structure is not included in the pNext chain of VkGraphicsPipelineCreateInfo, it is equivalent to specifying this structure with the following properties:
colorAttachmentCountset toVkPipelineRenderingCreateInfo::colorAttachmentCount.pColorAttachmentLocationsset toNULL.
This structure can be included in the pNext chain of a VkCommandBufferInheritanceInfo structure to specify inherited state from the primary command buffer. If VkCommandBufferInheritanceInfo::renderPass is not NULL_HANDLE, or COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT is not specified in VkCommandBufferBeginInfo::flags, members of this structure are ignored. If this structure is not included in the pNext chain of VkCommandBufferInheritanceInfo, it is equivalent to specifying this structure with the following properties:
colorAttachmentCountset toVkCommandBufferInheritanceRenderingInfo::colorAttachmentCount.pColorAttachmentLocationsset toNULL.
Valid Usage
- If the
dynamicRenderingLocalReadfeature is not enabled, andpColorAttachmentLocationsis notNULL, each element must be set to the value of its index within the array - Elements of
pColorAttachmentLocationsthat are notATTACHMENT_UNUSEDmust each be unique colorAttachmentCountmust be less than or equal tomaxColorAttachments- Each element of
pColorAttachmentLocationsmust be less thanmaxColorAttachments
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHR
See Also
CmdSetRenderingAttachmentLocationsKHR
Layout
struct VkRenderingAttachmentLocationInfoKHR {
VkStructureType sType();
void const * pNext();
uint32_t colorAttachmentCount();
uint32_t const * pColorAttachmentLocations();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkRenderingAttachmentLocationInfoKHRstructs.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 size in bytes.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
ConstructorsConstructorDescriptionVkRenderingAttachmentLocationInfoKHR(ByteBuffer container) Creates aVkRenderingAttachmentLocationInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkRenderingAttachmentLocationInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkRenderingAttachmentLocationInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.intthe number of elements inpColorAttachmentLocations.colorAttachmentCount(int value) Sets the specified value to thecolorAttachmentCount()field.create()Returns a newVkRenderingAttachmentLocationInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkRenderingAttachmentLocationInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkRenderingAttachmentLocationInfoKHR.Bufferinstance at the specified memory.createSafe(long address) createSafe(long address, int capacity) malloc()Returns a newVkRenderingAttachmentLocationInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkRenderingAttachmentLocationInfoKHRinstance 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 IntBuffernpColorAttachmentLocations(long struct) Unsafe version ofpColorAttachmentLocations.static voidnpColorAttachmentLocations(long struct, IntBuffer value) Unsafe version ofpColorAttachmentLocations.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.a pointer to an array ofcolorAttachmentCountuint32_tvalues defining remapped locations for color attachments.Sets the address of the specifiedIntBufferto thepColorAttachmentLocations()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHRvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, 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. -
COLORATTACHMENTCOUNT
public static final int COLORATTACHMENTCOUNTThe struct member offsets. -
PCOLORATTACHMENTLOCATIONS
public static final int PCOLORATTACHMENTLOCATIONSThe struct member offsets.
-
-
Constructor Details
-
VkRenderingAttachmentLocationInfoKHR
Creates aVkRenderingAttachmentLocationInfoKHRinstance 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<VkRenderingAttachmentLocationInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
colorAttachmentCount
public int colorAttachmentCount()the number of elements inpColorAttachmentLocations. -
pColorAttachmentLocations
a pointer to an array ofcolorAttachmentCountuint32_tvalues defining remapped locations for color attachments. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
colorAttachmentCount
Sets the specified value to thecolorAttachmentCount()field. -
pColorAttachmentLocations
Sets the address of the specifiedIntBufferto thepColorAttachmentLocations()field. -
set
public VkRenderingAttachmentLocationInfoKHR set(int sType, long pNext, int colorAttachmentCount, @Nullable IntBuffer pColorAttachmentLocations) 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 newVkRenderingAttachmentLocationInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkRenderingAttachmentLocationInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkRenderingAttachmentLocationInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkRenderingAttachmentLocationInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkRenderingAttachmentLocationInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkRenderingAttachmentLocationInfoKHR.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkRenderingAttachmentLocationInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkRenderingAttachmentLocationInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkRenderingAttachmentLocationInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRenderingAttachmentLocationInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkRenderingAttachmentLocationInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRenderingAttachmentLocationInfoKHR.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(). -
ncolorAttachmentCount
public static int ncolorAttachmentCount(long struct) Unsafe version ofcolorAttachmentCount(). -
npColorAttachmentLocations
Unsafe version ofpColorAttachmentLocations. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
ncolorAttachmentCount
public static void ncolorAttachmentCount(long struct, int value) Sets the specified value to thecolorAttachmentCountfield of the specifiedstruct. -
npColorAttachmentLocations
Unsafe version ofpColorAttachmentLocations.
-