Package org.lwjgl.vulkan
Class VkDescriptorBufferInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDescriptorBufferInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDescriptorBufferInfo extends Struct
Khronos Reference Page
Vulkan SpecificationValid Usage
buffermust be a validVkBufferhandleoffsetmust be less than the size ofbuffer- If
rangeis not equal toWHOLE_SIZE,rangemust be greater than 0 - If
rangeis not equal toWHOLE_SIZE,rangemust be less than or equal to the size ofbufferminusoffset
Member documentation
buffer– the buffer resourceoffset– the offset in bytes from the start of buffer. Access to buffer memory via this descriptor uses addressing that is relative to this starting offset.range– the size in bytes that is used for this descriptor update, orWHOLE_SIZEto use the range from offset to the end of the buffer
Layout
struct VkDescriptorBufferInfo { VkBuffer buffer; VkDeviceSize offset; VkDeviceSize range; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkDescriptorBufferInfo.BufferAn array ofVkDescriptorBufferInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkDescriptorBufferInfo(java.nio.ByteBuffer container)Creates aVkDescriptorBufferInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description longbuffer()Returns the value of thebufferfield.VkDescriptorBufferInfobuffer(long value)Sets the specified value to thebufferfield.static VkDescriptorBufferInfocalloc()Returns a newVkDescriptorBufferInfoinstance allocated withmemCalloc.static VkDescriptorBufferInfo.Buffercalloc(int capacity)Returns a newVkDescriptorBufferInfo.Bufferinstance allocated withmemCalloc.static VkDescriptorBufferInfocallocStack()Returns a newVkDescriptorBufferInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorBufferInfo.BuffercallocStack(int capacity)Returns a newVkDescriptorBufferInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorBufferInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkDescriptorBufferInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorBufferInfocallocStack(MemoryStack stack)Returns a newVkDescriptorBufferInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorBufferInfocreate()Returns a newVkDescriptorBufferInfoinstance allocated withBufferUtils.static VkDescriptorBufferInfo.Buffercreate(int capacity)Returns a newVkDescriptorBufferInfo.Bufferinstance allocated withBufferUtils.static VkDescriptorBufferInfocreate(long address)Returns a newVkDescriptorBufferInfoinstance for the specified memory address ornullif the address isNULL.static VkDescriptorBufferInfo.Buffercreate(long address, int capacity)Create aVkDescriptorBufferInfo.Bufferinstance at the specified memory.static VkDescriptorBufferInfomalloc()Returns a newVkDescriptorBufferInfoinstance allocated withmemAlloc.static VkDescriptorBufferInfo.Buffermalloc(int capacity)Returns a newVkDescriptorBufferInfo.Bufferinstance allocated withmemAlloc.static VkDescriptorBufferInfomallocStack()Returns a newVkDescriptorBufferInfoinstance allocated on the thread-localMemoryStack.static VkDescriptorBufferInfo.BuffermallocStack(int capacity)Returns a newVkDescriptorBufferInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkDescriptorBufferInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkDescriptorBufferInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkDescriptorBufferInfomallocStack(MemoryStack stack)Returns a newVkDescriptorBufferInfoinstance allocated on the specifiedMemoryStack.VkDescriptorBufferInfonset(long struct)Unsafe version ofset.longoffset()Returns the value of theoffsetfield.VkDescriptorBufferInfooffset(long value)Sets the specified value to theoffsetfield.longrange()Returns the value of therangefield.VkDescriptorBufferInforange(long value)Sets the specified value to therangefield.VkDescriptorBufferInfoset(long buffer, long offset, long range)Initializes this struct with the specified values.VkDescriptorBufferInfoset(VkDescriptorBufferInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkDescriptorBufferInfo
public VkDescriptorBufferInfo(java.nio.ByteBuffer container)
Creates aVkDescriptorBufferInfoinstance 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()
Description copied from class:StructReturns thesizeof(struct).
-
buffer
public long buffer()
Returns the value of thebufferfield.
-
offset
public long offset()
Returns the value of theoffsetfield.
-
range
public long range()
Returns the value of therangefield.
-
buffer
public VkDescriptorBufferInfo buffer(long value)
Sets the specified value to thebufferfield.
-
offset
public VkDescriptorBufferInfo offset(long value)
Sets the specified value to theoffsetfield.
-
range
public VkDescriptorBufferInfo range(long value)
Sets the specified value to therangefield.
-
set
public VkDescriptorBufferInfo set(long buffer, long offset, long range)
Initializes this struct with the specified values.
-
nset
public VkDescriptorBufferInfo nset(long struct)
Unsafe version ofset.
-
set
public VkDescriptorBufferInfo set(VkDescriptorBufferInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkDescriptorBufferInfo malloc()
Returns a newVkDescriptorBufferInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDescriptorBufferInfo calloc()
Returns a newVkDescriptorBufferInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDescriptorBufferInfo create()
Returns a newVkDescriptorBufferInfoinstance allocated withBufferUtils.
-
create
public static VkDescriptorBufferInfo create(long address)
Returns a newVkDescriptorBufferInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkDescriptorBufferInfo.Buffer malloc(int capacity)
Returns a newVkDescriptorBufferInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDescriptorBufferInfo.Buffer calloc(int capacity)
Returns a newVkDescriptorBufferInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorBufferInfo.Buffer create(int capacity)
Returns a newVkDescriptorBufferInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorBufferInfo.Buffer create(long address, int capacity)
Create aVkDescriptorBufferInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkDescriptorBufferInfo mallocStack()
Returns a newVkDescriptorBufferInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDescriptorBufferInfo callocStack()
Returns a newVkDescriptorBufferInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDescriptorBufferInfo mallocStack(MemoryStack stack)
Returns a newVkDescriptorBufferInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDescriptorBufferInfo callocStack(MemoryStack stack)
Returns a newVkDescriptorBufferInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkDescriptorBufferInfo.Buffer mallocStack(int capacity)
Returns a newVkDescriptorBufferInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDescriptorBufferInfo.Buffer callocStack(int capacity)
Returns a newVkDescriptorBufferInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkDescriptorBufferInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorBufferInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkDescriptorBufferInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorBufferInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-