Package org.lwjgl.vulkan
Class VkRenderingInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
- Direct Known Subclasses:
VkRenderingInfoKHR
struct VkRenderingInfo {
VkStructureType sType;
void const * pNext;
VkRenderingFlags flags;
{@link VkRect2D VkRect2D} renderArea;
uint32_t layerCount;
uint32_t viewMask;
uint32_t colorAttachmentCount;
{@link VkRenderingAttachmentInfo VkRenderingAttachmentInfo} const * pColorAttachments;
{@link VkRenderingAttachmentInfo VkRenderingAttachmentInfo} const * pDepthAttachment;
{@link VkRenderingAttachmentInfo VkRenderingAttachmentInfo} const * pStencilAttachment;
}
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorsConstructorDescriptionVkRenderingInfo
(ByteBuffer container) Creates aVkRenderingInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkRenderingInfo
calloc()
Returns a newVkRenderingInfo
instance allocated withmemCalloc
.static VkRenderingInfo.Buffer
calloc
(int capacity) Returns a newVkRenderingInfo.Buffer
instance allocated withmemCalloc
.static VkRenderingInfo.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkRenderingInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRenderingInfo
calloc
(MemoryStack stack) Returns a newVkRenderingInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.int
static VkRenderingInfo
create()
Returns a newVkRenderingInfo
instance allocated withBufferUtils
.static VkRenderingInfo.Buffer
create
(int capacity) Returns a newVkRenderingInfo.Buffer
instance allocated withBufferUtils
.static VkRenderingInfo
create
(long address) Returns a newVkRenderingInfo
instance for the specified memory address.static VkRenderingInfo.Buffer
create
(long address, int capacity) Create aVkRenderingInfo.Buffer
instance at the specified memory.static @Nullable VkRenderingInfo
createSafe
(long address) static @Nullable VkRenderingInfo.Buffer
createSafe
(long address, int capacity) int
flags()
flags
(int value) Sets the specified value to theflags
field.int
layerCount
(int value) Sets the specified value to thelayerCount
field.static VkRenderingInfo
malloc()
Returns a newVkRenderingInfo
instance allocated withmemAlloc
.static VkRenderingInfo.Buffer
malloc
(int capacity) Returns a newVkRenderingInfo.Buffer
instance allocated withmemAlloc
.static VkRenderingInfo.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkRenderingInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkRenderingInfo
malloc
(MemoryStack stack) Returns a newVkRenderingInfo
instance allocated on the specifiedMemoryStack
.static int
ncolorAttachmentCount
(long struct) Unsafe version ofcolorAttachmentCount()
.static void
ncolorAttachmentCount
(long struct, int value) Sets the specified value to thecolorAttachmentCount
field of the specifiedstruct
.static int
nflags
(long struct) Unsafe version offlags()
.static void
nflags
(long struct, int value) Unsafe version offlags
.static int
nlayerCount
(long struct) Unsafe version oflayerCount()
.static void
nlayerCount
(long struct, int value) Unsafe version oflayerCount
.static @Nullable VkRenderingAttachmentInfo.Buffer
npColorAttachments
(long struct) Unsafe version ofpColorAttachments()
.static void
npColorAttachments
(long struct, @Nullable VkRenderingAttachmentInfo.Buffer value) Unsafe version ofpColorAttachments
.static @Nullable VkRenderingAttachmentInfo
npDepthAttachment
(long struct) Unsafe version ofpDepthAttachment()
.static void
npDepthAttachment
(long struct, @Nullable VkRenderingAttachmentInfo value) Unsafe version ofpDepthAttachment
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static @Nullable VkRenderingAttachmentInfo
npStencilAttachment
(long struct) Unsafe version ofpStencilAttachment()
.static void
npStencilAttachment
(long struct, @Nullable VkRenderingAttachmentInfo value) Unsafe version ofpStencilAttachment
.static VkRect2D
nrenderArea
(long struct) Unsafe version ofrenderArea()
.static void
nrenderArea
(long struct, VkRect2D value) Unsafe version ofrenderArea
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.static int
nviewMask
(long struct) Unsafe version ofviewMask()
.static void
nviewMask
(long struct, int value) Unsafe version ofviewMask
.@Nullable VkRenderingAttachmentInfo.Buffer
pColorAttachments
(@Nullable VkRenderingAttachmentInfo.Buffer value) Sets the address of the specifiedVkRenderingAttachmentInfo.Buffer
to thepColorAttachments
field.@Nullable VkRenderingAttachmentInfo
pDepthAttachment
(@Nullable VkRenderingAttachmentInfo value) Sets the address of the specifiedVkRenderingAttachmentInfo
to thepDepthAttachment
field.long
pNext()
pNext
(long value) Sets the specified value to thepNext
field.Prepends the specifiedVkDeviceGroupRenderPassBeginInfo
value to thepNext
chain.Prepends the specifiedVkDeviceGroupRenderPassBeginInfoKHR
value to thepNext
chain.Prepends the specifiedVkMultisampledRenderToSingleSampledInfoEXT
value to thepNext
chain.Prepends the specifiedVkMultiviewPerViewAttributesInfoNVX
value to thepNext
chain.Prepends the specifiedVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
value to thepNext
chain.Prepends the specifiedVkRenderingFragmentDensityMapAttachmentInfoEXT
value to thepNext
chain.Prepends the specifiedVkRenderingFragmentShadingRateAttachmentInfoKHR
value to thepNext
chain.Prepends the specifiedVkRenderPassStripeBeginInfoARM
value to thepNext
chain.Prepends the specifiedVkRenderPassTileShadingCreateInfoQCOM
value to thepNext
chain.pNext
(VkTileMemorySizeInfoQCOM value) Prepends the specifiedVkTileMemorySizeInfoQCOM
value to thepNext
chain.@Nullable VkRenderingAttachmentInfo
pStencilAttachment
(@Nullable VkRenderingAttachmentInfo value) Sets the address of the specifiedVkRenderingAttachmentInfo
to thepStencilAttachment
field.renderArea
(Consumer<VkRect2D> consumer) Passes therenderArea
field to the specifiedConsumer
.renderArea
(VkRect2D value) Copies the specifiedVkRect2D
to therenderArea
field.set
(int sType, long pNext, int flags, VkRect2D renderArea, int layerCount, int viewMask, @Nullable VkRenderingAttachmentInfo.Buffer pColorAttachments, @Nullable VkRenderingAttachmentInfo pDepthAttachment, @Nullable VkRenderingAttachmentInfo pStencilAttachment) Initializes this struct with the specified values.set
(VkRenderingInfo src) Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
sType
(int value) Sets the specified value to thesType
field.Sets theSTRUCTURE_TYPE_RENDERING_INFO
value to thesType
field.static void
validate
(long struct) Validates pointer members that should not beNULL
.int
viewMask()
viewMask
(int value) Sets the specified value to theviewMask
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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. -
RENDERAREA
public static final int RENDERAREAThe struct member offsets. -
LAYERCOUNT
public static final int LAYERCOUNTThe struct member offsets. -
VIEWMASK
public static final int VIEWMASKThe struct member offsets. -
COLORATTACHMENTCOUNT
public static final int COLORATTACHMENTCOUNTThe struct member offsets. -
PCOLORATTACHMENTS
public static final int PCOLORATTACHMENTSThe struct member offsets. -
PDEPTHATTACHMENT
public static final int PDEPTHATTACHMENTThe struct member offsets. -
PSTENCILATTACHMENT
public static final int PSTENCILATTACHMENTThe struct member offsets.
-
-
Constructor Details
-
VkRenderingInfo
Creates aVkRenderingInfo
instance at the current position of the specifiedByteBuffer
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkRenderingInfo>
-
sType
public int sType()- Returns:
- the value of the
sType
field.
-
pNext
public long pNext()- Returns:
- the value of the
pNext
field.
-
flags
public int flags()- Returns:
- the value of the
flags
field.
-
renderArea
- Returns:
- a
VkRect2D
view of therenderArea
field.
-
layerCount
public int layerCount()- Returns:
- the value of the
layerCount
field.
-
viewMask
public int viewMask()- Returns:
- the value of the
viewMask
field.
-
colorAttachmentCount
public int colorAttachmentCount()- Returns:
- the value of the
colorAttachmentCount
field.
-
pColorAttachments
- Returns:
- a
VkRenderingAttachmentInfo.Buffer
view of the struct array pointed to by thepColorAttachments
field.
-
pDepthAttachment
- Returns:
- a
VkRenderingAttachmentInfo
view of the struct pointed to by thepDepthAttachment
field.
-
pStencilAttachment
- Returns:
- a
VkRenderingAttachmentInfo
view of the struct pointed to by thepStencilAttachment
field.
-
sType
Sets the specified value to thesType
field. -
sType$Default
Sets theSTRUCTURE_TYPE_RENDERING_INFO
value to thesType
field. -
pNext
Sets the specified value to thepNext
field. -
pNext
Prepends the specifiedVkDeviceGroupRenderPassBeginInfo
value to thepNext
chain. -
pNext
Prepends the specifiedVkDeviceGroupRenderPassBeginInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkMultisampledRenderToSingleSampledInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkMultiviewPerViewAttributesInfoNVX
value to thepNext
chain. -
pNext
Prepends the specifiedVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderPassStripeBeginInfoARM
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderPassTileShadingCreateInfoQCOM
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderingFragmentDensityMapAttachmentInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderingFragmentShadingRateAttachmentInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkTileMemorySizeInfoQCOM
value to thepNext
chain. -
flags
Sets the specified value to theflags
field. -
renderArea
Copies the specifiedVkRect2D
to therenderArea
field. -
renderArea
Passes therenderArea
field to the specifiedConsumer
. -
layerCount
Sets the specified value to thelayerCount
field. -
viewMask
Sets the specified value to theviewMask
field. -
pColorAttachments
Sets the address of the specifiedVkRenderingAttachmentInfo.Buffer
to thepColorAttachments
field. -
pDepthAttachment
Sets the address of the specifiedVkRenderingAttachmentInfo
to thepDepthAttachment
field. -
pStencilAttachment
Sets the address of the specifiedVkRenderingAttachmentInfo
to thepStencilAttachment
field. -
set
public VkRenderingInfo set(int sType, long pNext, int flags, VkRect2D renderArea, int layerCount, int viewMask, @Nullable VkRenderingAttachmentInfo.Buffer pColorAttachments, @Nullable VkRenderingAttachmentInfo pDepthAttachment, @Nullable VkRenderingAttachmentInfo pStencilAttachment) 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 newVkRenderingInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkRenderingInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkRenderingInfo
instance allocated withBufferUtils
. -
create
Returns a newVkRenderingInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkRenderingInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkRenderingInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkRenderingInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkRenderingInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
malloc
Returns a newVkRenderingInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkRenderingInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkRenderingInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkRenderingInfo.Buffer
instance allocated on the specifiedMemoryStack
and 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()
. -
nrenderArea
Unsafe version ofrenderArea()
. -
nlayerCount
public static int nlayerCount(long struct) Unsafe version oflayerCount()
. -
nviewMask
public static int nviewMask(long struct) Unsafe version ofviewMask()
. -
ncolorAttachmentCount
public static int ncolorAttachmentCount(long struct) Unsafe version ofcolorAttachmentCount()
. -
npColorAttachments
Unsafe version ofpColorAttachments()
. -
npDepthAttachment
Unsafe version ofpDepthAttachment()
. -
npStencilAttachment
Unsafe version ofpStencilAttachment()
. -
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
. -
nrenderArea
Unsafe version ofrenderArea
. -
nlayerCount
public static void nlayerCount(long struct, int value) Unsafe version oflayerCount
. -
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 thecolorAttachmentCount
field of the specifiedstruct
. -
npColorAttachments
public static void npColorAttachments(long struct, @Nullable VkRenderingAttachmentInfo.Buffer value) Unsafe version ofpColorAttachments
. -
npDepthAttachment
Unsafe version ofpDepthAttachment
. -
npStencilAttachment
Unsafe version ofpStencilAttachment
. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-