Package org.lwjgl.vulkan
Class VkRenderPassBeginInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
struct VkRenderPassBeginInfo {
VkStructureType sType;
void const * pNext;
VkRenderPass renderPass;
VkFramebuffer framebuffer;
{@link VkRect2D VkRect2D} renderArea;
uint32_t clearValueCount;
{@link VkClearValue VkClearValue} const * pClearValues;
}
-
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 size in bytes.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
ConstructorsConstructorDescriptionVkRenderPassBeginInfo
(ByteBuffer container) Creates aVkRenderPassBeginInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkRenderPassBeginInfo
calloc()
Returns a newVkRenderPassBeginInfo
instance allocated withmemCalloc
.static VkRenderPassBeginInfo.Buffer
calloc
(int capacity) Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withmemCalloc
.static VkRenderPassBeginInfo.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRenderPassBeginInfo
calloc
(MemoryStack stack) Returns a newVkRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRenderPassBeginInfo
Deprecated.static VkRenderPassBeginInfo.Buffer
callocStack
(int capacity) Deprecated.static VkRenderPassBeginInfo.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkRenderPassBeginInfo
callocStack
(MemoryStack stack) Deprecated.int
clearValueCount
(int value) Sets the specified value to theclearValueCount
field.static VkRenderPassBeginInfo
create()
Returns a newVkRenderPassBeginInfo
instance allocated withBufferUtils
.static VkRenderPassBeginInfo.Buffer
create
(int capacity) Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withBufferUtils
.static VkRenderPassBeginInfo
create
(long address) Returns a newVkRenderPassBeginInfo
instance for the specified memory address.static VkRenderPassBeginInfo.Buffer
create
(long address, int capacity) Create aVkRenderPassBeginInfo.Buffer
instance at the specified memory.static @Nullable VkRenderPassBeginInfo
createSafe
(long address) static @Nullable VkRenderPassBeginInfo.Buffer
createSafe
(long address, int capacity) long
framebuffer
(long value) Sets the specified value to theframebuffer
field.static VkRenderPassBeginInfo
malloc()
Returns a newVkRenderPassBeginInfo
instance allocated withmemAlloc
.static VkRenderPassBeginInfo.Buffer
malloc
(int capacity) Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withmemAlloc
.static VkRenderPassBeginInfo.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkRenderPassBeginInfo
malloc
(MemoryStack stack) Returns a newVkRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
.static VkRenderPassBeginInfo
Deprecated.static VkRenderPassBeginInfo.Buffer
mallocStack
(int capacity) Deprecated.static VkRenderPassBeginInfo.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkRenderPassBeginInfo
mallocStack
(MemoryStack stack) Deprecated.static int
nclearValueCount
(long struct) Unsafe version ofclearValueCount()
.static void
nclearValueCount
(long struct, int value) Sets the specified value to theclearValueCount
field of the specifiedstruct
.static long
nframebuffer
(long struct) Unsafe version offramebuffer()
.static void
nframebuffer
(long struct, long value) Unsafe version offramebuffer
.static @Nullable VkClearValue.Buffer
npClearValues
(long struct) Unsafe version ofpClearValues()
.static void
npClearValues
(long struct, @Nullable VkClearValue.Buffer value) Unsafe version ofpClearValues
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static VkRect2D
nrenderArea
(long struct) Unsafe version ofrenderArea()
.static void
nrenderArea
(long struct, VkRect2D value) Unsafe version ofrenderArea
.static long
nrenderPass
(long struct) Unsafe version ofrenderPass()
.static void
nrenderPass
(long struct, long value) Unsafe version ofrenderPass
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.@Nullable VkClearValue.Buffer
pClearValues
(@Nullable VkClearValue.Buffer value) Sets the address of the specifiedVkClearValue.Buffer
to thepClearValues
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 specifiedVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
value to thepNext
chain.Prepends the specifiedVkRenderPassAttachmentBeginInfo
value to thepNext
chain.Prepends the specifiedVkRenderPassAttachmentBeginInfoKHR
value to thepNext
chain.Prepends the specifiedVkRenderPassSampleLocationsBeginInfoEXT
value to thepNext
chain.Prepends the specifiedVkRenderPassStripeBeginInfoARM
value to thepNext
chain.Prepends the specifiedVkRenderPassTransformBeginInfoQCOM
value to thepNext
chain.renderArea
(Consumer<VkRect2D> consumer) Passes therenderArea
field to the specifiedConsumer
.renderArea
(VkRect2D value) Copies the specifiedVkRect2D
to therenderArea
field.long
renderPass
(long value) Sets the specified value to therenderPass
field.set
(int sType, long pNext, long renderPass, long framebuffer, VkRect2D renderArea, int clearValueCount, @Nullable VkClearValue.Buffer pClearValues) Initializes this struct with the specified values.set
(VkRenderPassBeginInfo 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_RENDER_PASS_BEGIN_INFO
value to thesType
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. -
RENDERPASS
public static final int RENDERPASSThe struct member offsets. -
FRAMEBUFFER
public static final int FRAMEBUFFERThe struct member offsets. -
RENDERAREA
public static final int RENDERAREAThe struct member offsets. -
CLEARVALUECOUNT
public static final int CLEARVALUECOUNTThe struct member offsets. -
PCLEARVALUES
public static final int PCLEARVALUESThe struct member offsets.
-
-
Constructor Details
-
VkRenderPassBeginInfo
Creates aVkRenderPassBeginInfo
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<VkRenderPassBeginInfo>
-
sType
public int sType()- Returns:
- the value of the
sType
field.
-
pNext
public long pNext()- Returns:
- the value of the
pNext
field.
-
renderPass
public long renderPass()- Returns:
- the value of the
renderPass
field.
-
framebuffer
public long framebuffer()- Returns:
- the value of the
framebuffer
field.
-
renderArea
- Returns:
- a
VkRect2D
view of therenderArea
field.
-
clearValueCount
public int clearValueCount()- Returns:
- the value of the
clearValueCount
field.
-
pClearValues
- Returns:
- a
VkClearValue.Buffer
view of the struct array pointed to by thepClearValues
field.
-
sType
Sets the specified value to thesType
field. -
sType$Default
Sets theSTRUCTURE_TYPE_RENDER_PASS_BEGIN_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 specifiedVkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderPassAttachmentBeginInfo
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderPassAttachmentBeginInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderPassSampleLocationsBeginInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderPassStripeBeginInfoARM
value to thepNext
chain. -
pNext
Prepends the specifiedVkRenderPassTransformBeginInfoQCOM
value to thepNext
chain. -
renderPass
Sets the specified value to therenderPass
field. -
framebuffer
Sets the specified value to theframebuffer
field. -
renderArea
Copies the specifiedVkRect2D
to therenderArea
field. -
renderArea
Passes therenderArea
field to the specifiedConsumer
. -
clearValueCount
Sets the specified value to theclearValueCount
field. -
pClearValues
Sets the address of the specifiedVkClearValue.Buffer
to thepClearValues
field. -
set
public VkRenderPassBeginInfo set(int sType, long pNext, long renderPass, long framebuffer, VkRect2D renderArea, int clearValueCount, @Nullable VkClearValue.Buffer pClearValues) 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 newVkRenderPassBeginInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkRenderPassBeginInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkRenderPassBeginInfo
instance allocated withBufferUtils
. -
create
Returns a newVkRenderPassBeginInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkRenderPassBeginInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkRenderPassBeginInfo.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()
. -
nrenderPass
public static long nrenderPass(long struct) Unsafe version ofrenderPass()
. -
nframebuffer
public static long nframebuffer(long struct) Unsafe version offramebuffer()
. -
nrenderArea
Unsafe version ofrenderArea()
. -
nclearValueCount
public static int nclearValueCount(long struct) Unsafe version ofclearValueCount()
. -
npClearValues
Unsafe version ofpClearValues()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nrenderPass
public static void nrenderPass(long struct, long value) Unsafe version ofrenderPass
. -
nframebuffer
public static void nframebuffer(long struct, long value) Unsafe version offramebuffer
. -
nrenderArea
Unsafe version ofrenderArea
. -
nclearValueCount
public static void nclearValueCount(long struct, int value) Sets the specified value to theclearValueCount
field of the specifiedstruct
. -
npClearValues
Unsafe version ofpClearValues
.
-