Package org.lwjgl.vulkan
Class VkRenderPassBeginInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkRenderPassBeginInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkRenderPassBeginInfo extends Struct
Khronos Reference Page
Vulkan SpecificationIndicates the render pass to begin an instance of, and the framebuffer the instance uses.
Valid Usage
sType
must beSTRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO
pNext
must beNULL
renderPass
must be a validVkRenderPass
handleframebuffer
must be a validVkFramebuffer
handle- If
clearValueCount
is not 0,pClearValues
must be a pointer to an array ofclearValueCount
VkClearValue
unions - Each of
renderPass
andframebuffer
must have been created, allocated or retrieved from the sameVkDevice
clearValueCount
must be greater than or equal to the number of attachments inrenderPass
that specify aloadOp
ofATTACHMENT_LOAD_OP_CLEAR
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO
pNext
– reserved for use by extensionsrenderPass
– the render pass to begin an instance offramebuffer
– the framebuffer containing the attachments that are used with the render passrenderArea
– the render area that is affected by the render pass instanceclearValueCount
– the number of elements inpClearValues
pClearValues
– an array ofVkClearValue
structures that contains clear values for each attachment, if the attachment uses aloadOp
value ofATTACHMENT_LOAD_OP_CLEAR
. The array is indexed by attachment number. Only elements corresponding to cleared attachments are used. Other elements ofpClearValues
are ignored.
Layout
struct VkRenderPassBeginInfo { VkStructureType sType; const void * pNext; VkRenderPass renderPass; VkFramebuffer framebuffer;
VkRect2D
renderArea; uint32_t clearValueCount; const VkClearValue * pClearValues; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkRenderPassBeginInfo.Buffer
An array ofVkRenderPassBeginInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkRenderPassBeginInfo(java.nio.ByteBuffer container)
Creates aVkRenderPassBeginInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkRenderPassBeginInfo
calloc()
Returns a newVkRenderPassBeginInfo
instance allocated withmemCalloc
.static VkRenderPassBeginInfo.Buffer
calloc(int capacity)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withmemCalloc
.static VkRenderPassBeginInfo
callocStack()
Returns a newVkRenderPassBeginInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRenderPassBeginInfo.Buffer
callocStack(int capacity)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRenderPassBeginInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRenderPassBeginInfo
callocStack(MemoryStack stack)
Returns a newVkRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.int
clearValueCount()
Returns the value of 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 ornull
if the address isNULL
.static VkRenderPassBeginInfo.Buffer
create(long address, int capacity)
Create aVkRenderPassBeginInfo.Buffer
instance at the specified memory.long
framebuffer()
Returns the value of theframebuffer
field.VkRenderPassBeginInfo
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
mallocStack()
Returns a newVkRenderPassBeginInfo
instance allocated on the thread-localMemoryStack
.static VkRenderPassBeginInfo.Buffer
mallocStack(int capacity)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkRenderPassBeginInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkRenderPassBeginInfo
mallocStack(MemoryStack stack)
Returns a newVkRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
.VkRenderPassBeginInfo
nset(long struct)
Unsafe version ofset
.VkClearValue.Buffer
pClearValues()
Returns aVkClearValue.Buffer
view of the struct array pointed to by thepClearValues
field.VkRenderPassBeginInfo
pClearValues(VkClearValue.Buffer value)
Sets the address of the specifiedVkClearValue.Buffer
to thepClearValues
field.long
pNext()
Returns the value of thepNext
field.VkRenderPassBeginInfo
pNext(long value)
Sets the specified value to thepNext
field.VkRect2D
renderArea()
Returns aVkRect2D
view of therenderArea
field.VkRenderPassBeginInfo
renderArea(VkRect2D value)
Copies the specifiedVkRect2D
to therenderArea
field.long
renderPass()
Returns the value of therenderPass
field.VkRenderPassBeginInfo
renderPass(long value)
Sets the specified value to therenderPass
field.VkRenderPassBeginInfo
set(int sType, long pNext, long renderPass, long framebuffer, VkRect2D renderArea, VkClearValue.Buffer pClearValues)
Initializes this struct with the specified values.VkRenderPassBeginInfo
set(VkRenderPassBeginInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkRenderPassBeginInfo
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
CallsVkRenderPassBeginInfo.validate(long)
for each struct contained in the specified struct array.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkRenderPassBeginInfo
public VkRenderPassBeginInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
renderPass
public long renderPass()
Returns the value of therenderPass
field.
-
framebuffer
public long framebuffer()
Returns the value of theframebuffer
field.
-
clearValueCount
public int clearValueCount()
Returns the value of theclearValueCount
field.
-
pClearValues
public VkClearValue.Buffer pClearValues()
Returns aVkClearValue.Buffer
view of the struct array pointed to by thepClearValues
field.
-
sType
public VkRenderPassBeginInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkRenderPassBeginInfo pNext(long value)
Sets the specified value to thepNext
field.
-
renderPass
public VkRenderPassBeginInfo renderPass(long value)
Sets the specified value to therenderPass
field.
-
framebuffer
public VkRenderPassBeginInfo framebuffer(long value)
Sets the specified value to theframebuffer
field.
-
renderArea
public VkRenderPassBeginInfo renderArea(VkRect2D value)
Copies the specifiedVkRect2D
to therenderArea
field.
-
pClearValues
public VkRenderPassBeginInfo pClearValues(VkClearValue.Buffer value)
Sets the address of the specifiedVkClearValue.Buffer
to thepClearValues
field.
-
set
public VkRenderPassBeginInfo set(int sType, long pNext, long renderPass, long framebuffer, VkRect2D renderArea, VkClearValue.Buffer pClearValues)
Initializes this struct with the specified values.
-
nset
public VkRenderPassBeginInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkRenderPassBeginInfo set(VkRenderPassBeginInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkRenderPassBeginInfo malloc()
Returns a newVkRenderPassBeginInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkRenderPassBeginInfo calloc()
Returns a newVkRenderPassBeginInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkRenderPassBeginInfo create()
Returns a newVkRenderPassBeginInfo
instance allocated withBufferUtils
.
-
create
public static VkRenderPassBeginInfo create(long address)
Returns a newVkRenderPassBeginInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkRenderPassBeginInfo.Buffer malloc(int capacity)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkRenderPassBeginInfo.Buffer calloc(int capacity)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRenderPassBeginInfo.Buffer create(int capacity)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRenderPassBeginInfo.Buffer create(long address, int capacity)
Create aVkRenderPassBeginInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkRenderPassBeginInfo mallocStack()
Returns a newVkRenderPassBeginInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkRenderPassBeginInfo callocStack()
Returns a newVkRenderPassBeginInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkRenderPassBeginInfo mallocStack(MemoryStack stack)
Returns a newVkRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkRenderPassBeginInfo callocStack(MemoryStack stack)
Returns a newVkRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkRenderPassBeginInfo.Buffer mallocStack(int capacity)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkRenderPassBeginInfo.Buffer callocStack(int capacity)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkRenderPassBeginInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkRenderPassBeginInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
CallsVkRenderPassBeginInfo.validate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-