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
buffer
must be a validVkBuffer
handleoffset
must be less than the size ofbuffer
- If
range
is not equal toWHOLE_SIZE
,range
must be greater than 0 - If
range
is not equal toWHOLE_SIZE
,range
must be less than or equal to the size ofbuffer
minusoffset
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_SIZE
to 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 class
VkDescriptorBufferInfo.Buffer
An array ofVkDescriptorBufferInfo
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 VkDescriptorBufferInfo(java.nio.ByteBuffer container)
Creates aVkDescriptorBufferInfo
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 long
buffer()
Returns the value of thebuffer
field.VkDescriptorBufferInfo
buffer(long value)
Sets the specified value to thebuffer
field.static VkDescriptorBufferInfo
calloc()
Returns a newVkDescriptorBufferInfo
instance allocated withmemCalloc
.static VkDescriptorBufferInfo.Buffer
calloc(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated withmemCalloc
.static VkDescriptorBufferInfo
callocStack()
Returns a newVkDescriptorBufferInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDescriptorBufferInfo.Buffer
callocStack(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDescriptorBufferInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorBufferInfo
callocStack(MemoryStack stack)
Returns a newVkDescriptorBufferInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorBufferInfo
create()
Returns a newVkDescriptorBufferInfo
instance allocated withBufferUtils
.static VkDescriptorBufferInfo.Buffer
create(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated withBufferUtils
.static VkDescriptorBufferInfo
create(long address)
Returns a newVkDescriptorBufferInfo
instance for the specified memory address ornull
if the address isNULL
.static VkDescriptorBufferInfo.Buffer
create(long address, int capacity)
Create aVkDescriptorBufferInfo.Buffer
instance at the specified memory.static VkDescriptorBufferInfo
malloc()
Returns a newVkDescriptorBufferInfo
instance allocated withmemAlloc
.static VkDescriptorBufferInfo.Buffer
malloc(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated withmemAlloc
.static VkDescriptorBufferInfo
mallocStack()
Returns a newVkDescriptorBufferInfo
instance allocated on the thread-localMemoryStack
.static VkDescriptorBufferInfo.Buffer
mallocStack(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkDescriptorBufferInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkDescriptorBufferInfo
mallocStack(MemoryStack stack)
Returns a newVkDescriptorBufferInfo
instance allocated on the specifiedMemoryStack
.VkDescriptorBufferInfo
nset(long struct)
Unsafe version ofset
.long
offset()
Returns the value of theoffset
field.VkDescriptorBufferInfo
offset(long value)
Sets the specified value to theoffset
field.long
range()
Returns the value of therange
field.VkDescriptorBufferInfo
range(long value)
Sets the specified value to therange
field.VkDescriptorBufferInfo
set(long buffer, long offset, long range)
Initializes this struct with the specified values.VkDescriptorBufferInfo
set(VkDescriptorBufferInfo src)
Copies the specified struct data to this struct.int
sizeof()
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 aVkDescriptorBufferInfo
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)
.
-
buffer
public long buffer()
Returns the value of thebuffer
field.
-
offset
public long offset()
Returns the value of theoffset
field.
-
range
public long range()
Returns the value of therange
field.
-
buffer
public VkDescriptorBufferInfo buffer(long value)
Sets the specified value to thebuffer
field.
-
offset
public VkDescriptorBufferInfo offset(long value)
Sets the specified value to theoffset
field.
-
range
public VkDescriptorBufferInfo range(long value)
Sets the specified value to therange
field.
-
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 newVkDescriptorBufferInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDescriptorBufferInfo calloc()
Returns a newVkDescriptorBufferInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDescriptorBufferInfo create()
Returns a newVkDescriptorBufferInfo
instance allocated withBufferUtils
.
-
create
public static VkDescriptorBufferInfo create(long address)
Returns a newVkDescriptorBufferInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkDescriptorBufferInfo.Buffer malloc(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDescriptorBufferInfo.Buffer calloc(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDescriptorBufferInfo.Buffer create(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDescriptorBufferInfo.Buffer create(long address, int capacity)
Create aVkDescriptorBufferInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkDescriptorBufferInfo mallocStack()
Returns a newVkDescriptorBufferInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDescriptorBufferInfo callocStack()
Returns a newVkDescriptorBufferInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDescriptorBufferInfo mallocStack(MemoryStack stack)
Returns a newVkDescriptorBufferInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDescriptorBufferInfo callocStack(MemoryStack stack)
Returns a newVkDescriptorBufferInfo
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDescriptorBufferInfo.Buffer callocStack(int capacity)
Returns a newVkDescriptorBufferInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDescriptorBufferInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorBufferInfo.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-