Package org.lwjgl.vulkan
Class VkRenderPassAttachmentBeginInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkRenderPassAttachmentBeginInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkRenderPassAttachmentBeginInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying images to be used as framebuffer attachments.Valid Usage
- Each element of
pAttachments
must only specify a single mip level - Each element of
pAttachments
must have been created with the identity swizzle
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_RENDER_PASS_ATTACHMENT_BEGIN_INFO_KHR
- If
attachmentCount
is not 0,pAttachments
must be a valid pointer to an array ofattachmentCount
validVkImageView
handles
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.attachmentCount
– the number of attachments.pAttachments
– an array ofVkImageView
handles, each of which will be used as the corresponding attachment in the render pass instance.
Layout
struct VkRenderPassAttachmentBeginInfoKHR { VkStructureType sType; void const * pNext; uint32_t attachmentCount; VkImageView const * pAttachments; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkRenderPassAttachmentBeginInfoKHR.Buffer
An array ofVkRenderPassAttachmentBeginInfoKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
ATTACHMENTCOUNT
PATTACHMENTS
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkRenderPassAttachmentBeginInfoKHR(java.nio.ByteBuffer container)
Creates aVkRenderPassAttachmentBeginInfoKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
attachmentCount()
Returns the value of theattachmentCount
field.static VkRenderPassAttachmentBeginInfoKHR
calloc()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated withmemCalloc
.static VkRenderPassAttachmentBeginInfoKHR.Buffer
calloc(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated withmemCalloc
.static VkRenderPassAttachmentBeginInfoKHR
callocStack()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRenderPassAttachmentBeginInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkRenderPassAttachmentBeginInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRenderPassAttachmentBeginInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkRenderPassAttachmentBeginInfoKHR
create()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated withBufferUtils
.static VkRenderPassAttachmentBeginInfoKHR.Buffer
create(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated withBufferUtils
.static VkRenderPassAttachmentBeginInfoKHR
create(long address)
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance for the specified memory address.static VkRenderPassAttachmentBeginInfoKHR.Buffer
create(long address, int capacity)
Create aVkRenderPassAttachmentBeginInfoKHR.Buffer
instance at the specified memory.static VkRenderPassAttachmentBeginInfoKHR
createSafe(long address)
static VkRenderPassAttachmentBeginInfoKHR.Buffer
createSafe(long address, int capacity)
static VkRenderPassAttachmentBeginInfoKHR
malloc()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated withmemAlloc
.static VkRenderPassAttachmentBeginInfoKHR.Buffer
malloc(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated withmemAlloc
.static VkRenderPassAttachmentBeginInfoKHR
mallocStack()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated on the thread-localMemoryStack
.static VkRenderPassAttachmentBeginInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkRenderPassAttachmentBeginInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkRenderPassAttachmentBeginInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated on the specifiedMemoryStack
.static int
nattachmentCount(long struct)
Unsafe version ofattachmentCount()
.static void
nattachmentCount(long struct, int value)
Sets the specified value to theattachmentCount
field of the specifiedstruct
.static java.nio.LongBuffer
npAttachments(long struct)
Unsafe version ofpAttachments
.static void
npAttachments(long struct, java.nio.LongBuffer value)
Unsafe version ofpAttachments
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.java.nio.LongBuffer
pAttachments()
Returns aLongBuffer
view of the data pointed to by thepAttachments
field.VkRenderPassAttachmentBeginInfoKHR
pAttachments(java.nio.LongBuffer value)
Sets the address of the specifiedLongBuffer
to thepAttachments
field.long
pNext()
Returns the value of thepNext
field.VkRenderPassAttachmentBeginInfoKHR
pNext(long value)
Sets the specified value to thepNext
field.VkRenderPassAttachmentBeginInfoKHR
set(int sType, long pNext, java.nio.LongBuffer pAttachments)
Initializes this struct with the specified values.VkRenderPassAttachmentBeginInfoKHR
set(VkRenderPassAttachmentBeginInfoKHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkRenderPassAttachmentBeginInfoKHR
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)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkRenderPassAttachmentBeginInfoKHR
public VkRenderPassAttachmentBeginInfoKHR(java.nio.ByteBuffer container)
Creates aVkRenderPassAttachmentBeginInfoKHR
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()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
attachmentCount
public int attachmentCount()
Returns the value of theattachmentCount
field.
-
pAttachments
@Nullable public java.nio.LongBuffer pAttachments()
Returns aLongBuffer
view of the data pointed to by thepAttachments
field.
-
sType
public VkRenderPassAttachmentBeginInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkRenderPassAttachmentBeginInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
pAttachments
public VkRenderPassAttachmentBeginInfoKHR pAttachments(@Nullable java.nio.LongBuffer value)
Sets the address of the specifiedLongBuffer
to thepAttachments
field.
-
set
public VkRenderPassAttachmentBeginInfoKHR set(int sType, long pNext, @Nullable java.nio.LongBuffer pAttachments)
Initializes this struct with the specified values.
-
set
public VkRenderPassAttachmentBeginInfoKHR set(VkRenderPassAttachmentBeginInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkRenderPassAttachmentBeginInfoKHR malloc()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkRenderPassAttachmentBeginInfoKHR calloc()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkRenderPassAttachmentBeginInfoKHR create()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkRenderPassAttachmentBeginInfoKHR create(long address)
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkRenderPassAttachmentBeginInfoKHR createSafe(long address)
-
malloc
public static VkRenderPassAttachmentBeginInfoKHR.Buffer malloc(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkRenderPassAttachmentBeginInfoKHR.Buffer calloc(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRenderPassAttachmentBeginInfoKHR.Buffer create(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkRenderPassAttachmentBeginInfoKHR.Buffer create(long address, int capacity)
Create aVkRenderPassAttachmentBeginInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkRenderPassAttachmentBeginInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkRenderPassAttachmentBeginInfoKHR mallocStack()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkRenderPassAttachmentBeginInfoKHR callocStack()
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkRenderPassAttachmentBeginInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkRenderPassAttachmentBeginInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkRenderPassAttachmentBeginInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkRenderPassAttachmentBeginInfoKHR.Buffer callocStack(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkRenderPassAttachmentBeginInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkRenderPassAttachmentBeginInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nattachmentCount
public static int nattachmentCount(long struct)
Unsafe version ofattachmentCount()
.
-
npAttachments
@Nullable public static java.nio.LongBuffer npAttachments(long struct)
Unsafe version ofpAttachments
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nattachmentCount
public static void nattachmentCount(long struct, int value)
Sets the specified value to theattachmentCount
field of the specifiedstruct
.
-
npAttachments
public static void npAttachments(long struct, @Nullable java.nio.LongBuffer value)
Unsafe version ofpAttachments
.
-
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)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-