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.NativeResourceStructure specifying images to be used as framebuffer attachments.Valid Usage
- Each element of
pAttachmentsmust only specify a single mip level - Each element of
pAttachmentsmust have been created with the identity swizzle
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_RENDER_PASS_ATTACHMENT_BEGIN_INFO_KHR- If
attachmentCountis not 0,pAttachmentsmust be a valid pointer to an array ofattachmentCountvalidVkImageViewhandles
Member documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.attachmentCount– the number of attachments.pAttachments– an array ofVkImageViewhandles, 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 classVkRenderPassAttachmentBeginInfoKHR.BufferAn array ofVkRenderPassAttachmentBeginInfoKHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intATTACHMENTCOUNT
PATTACHMENTS
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkRenderPassAttachmentBeginInfoKHR(java.nio.ByteBuffer container)Creates aVkRenderPassAttachmentBeginInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intattachmentCount()Returns the value of theattachmentCountfield.static VkRenderPassAttachmentBeginInfoKHRcalloc()Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated withmemCalloc.static VkRenderPassAttachmentBeginInfoKHR.Buffercalloc(int capacity)Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated withmemCalloc.static VkRenderPassAttachmentBeginInfoKHRcallocStack()Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkRenderPassAttachmentBeginInfoKHR.BuffercallocStack(int capacity)Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkRenderPassAttachmentBeginInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRenderPassAttachmentBeginInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRenderPassAttachmentBeginInfoKHRcreate()Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated withBufferUtils.static VkRenderPassAttachmentBeginInfoKHR.Buffercreate(int capacity)Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated withBufferUtils.static VkRenderPassAttachmentBeginInfoKHRcreate(long address)Returns a newVkRenderPassAttachmentBeginInfoKHRinstance for the specified memory address.static VkRenderPassAttachmentBeginInfoKHR.Buffercreate(long address, int capacity)Create aVkRenderPassAttachmentBeginInfoKHR.Bufferinstance at the specified memory.static VkRenderPassAttachmentBeginInfoKHRcreateSafe(long address)static VkRenderPassAttachmentBeginInfoKHR.BuffercreateSafe(long address, int capacity)static VkRenderPassAttachmentBeginInfoKHRmalloc()Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated withmemAlloc.static VkRenderPassAttachmentBeginInfoKHR.Buffermalloc(int capacity)Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated withmemAlloc.static VkRenderPassAttachmentBeginInfoKHRmallocStack()Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated on the thread-localMemoryStack.static VkRenderPassAttachmentBeginInfoKHR.BuffermallocStack(int capacity)Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkRenderPassAttachmentBeginInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkRenderPassAttachmentBeginInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated on the specifiedMemoryStack.static intnattachmentCount(long struct)Unsafe version ofattachmentCount().static voidnattachmentCount(long struct, int value)Sets the specified value to theattachmentCountfield of the specifiedstruct.static java.nio.LongBuffernpAttachments(long struct)Unsafe version ofpAttachments.static voidnpAttachments(long struct, java.nio.LongBuffer value)Unsafe version ofpAttachments.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.java.nio.LongBufferpAttachments()Returns aLongBufferview of the data pointed to by thepAttachmentsfield.VkRenderPassAttachmentBeginInfoKHRpAttachments(java.nio.LongBuffer value)Sets the address of the specifiedLongBufferto thepAttachmentsfield.longpNext()Returns the value of thepNextfield.VkRenderPassAttachmentBeginInfoKHRpNext(long value)Sets the specified value to thepNextfield.VkRenderPassAttachmentBeginInfoKHRset(int sType, long pNext, java.nio.LongBuffer pAttachments)Initializes this struct with the specified values.VkRenderPassAttachmentBeginInfoKHRset(VkRenderPassAttachmentBeginInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkRenderPassAttachmentBeginInfoKHRsType(int value)Sets the specified value to thesTypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(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 aVkRenderPassAttachmentBeginInfoKHRinstance 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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
attachmentCount
public int attachmentCount()
Returns the value of theattachmentCountfield.
-
pAttachments
@Nullable public java.nio.LongBuffer pAttachments()
Returns aLongBufferview of the data pointed to by thepAttachmentsfield.
-
sType
public VkRenderPassAttachmentBeginInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkRenderPassAttachmentBeginInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
pAttachments
public VkRenderPassAttachmentBeginInfoKHR pAttachments(@Nullable java.nio.LongBuffer value)
Sets the address of the specifiedLongBufferto thepAttachmentsfield.
-
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 newVkRenderPassAttachmentBeginInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkRenderPassAttachmentBeginInfoKHR calloc()
Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkRenderPassAttachmentBeginInfoKHR create()
Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated withBufferUtils.
-
create
public static VkRenderPassAttachmentBeginInfoKHR create(long address)
Returns a newVkRenderPassAttachmentBeginInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkRenderPassAttachmentBeginInfoKHR createSafe(long address)
-
malloc
public static VkRenderPassAttachmentBeginInfoKHR.Buffer malloc(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkRenderPassAttachmentBeginInfoKHR.Buffer calloc(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkRenderPassAttachmentBeginInfoKHR.Buffer create(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkRenderPassAttachmentBeginInfoKHR.Buffer create(long address, int capacity)
Create aVkRenderPassAttachmentBeginInfoKHR.Bufferinstance 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 newVkRenderPassAttachmentBeginInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkRenderPassAttachmentBeginInfoKHR callocStack()
Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkRenderPassAttachmentBeginInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkRenderPassAttachmentBeginInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderPassAttachmentBeginInfoKHRinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkRenderPassAttachmentBeginInfoKHR.Buffer callocStack(int capacity)
Returns a newVkRenderPassAttachmentBeginInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand 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.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand 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 theattachmentCountfield 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
-
-