Package org.lwjgl.vulkan
Class VkSparseImageMemoryBindInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSparseImageMemoryBindInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkSparseImageMemoryBindInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying sparse image memory bind info.Valid Usage
- The
subresource.mipLevel
member of each element ofpBinds
must be less than themipLevels
specified inVkImageCreateInfo
whenimage
was created - The
subresource.arrayLayer
member of each element ofpBinds
must be less than thearrayLayers
specified inVkImageCreateInfo
whenimage
was created
Valid Usage (Implicit)
image
must be a validVkImage
handlepBinds
must be a valid pointer to an array ofbindCount
validVkSparseImageMemoryBind
structuresbindCount
must be greater than 0
See Also
VkBindSparseInfo
,VkSparseImageMemoryBind
Member documentation
image
– theVkImage
object to be boundbindCount
– the number ofVkSparseImageMemoryBind
structures inpBinds
arraypBinds
– a pointer to array ofVkSparseImageMemoryBind
structures
Layout
struct VkSparseImageMemoryBindInfo { VkImage image; uint32_t bindCount;
VkSparseImageMemoryBind
const * pBinds; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkSparseImageMemoryBindInfo.Buffer
An array ofVkSparseImageMemoryBindInfo
structs.
-
Constructor Summary
Constructors Constructor Description VkSparseImageMemoryBindInfo(java.nio.ByteBuffer container)
Creates aVkSparseImageMemoryBindInfo
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
bindCount()
Returns the value of thebindCount
field.static VkSparseImageMemoryBindInfo
calloc()
Returns a newVkSparseImageMemoryBindInfo
instance allocated withmemCalloc
.static VkSparseImageMemoryBindInfo.Buffer
calloc(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated withmemCalloc
.static VkSparseImageMemoryBindInfo
callocStack()
Returns a newVkSparseImageMemoryBindInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseImageMemoryBindInfo.Buffer
callocStack(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseImageMemoryBindInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageMemoryBindInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageMemoryBindInfo
create()
Returns a newVkSparseImageMemoryBindInfo
instance allocated withBufferUtils
.static VkSparseImageMemoryBindInfo.Buffer
create(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated withBufferUtils
.static VkSparseImageMemoryBindInfo
create(long address)
Returns a newVkSparseImageMemoryBindInfo
instance for the specified memory address.static VkSparseImageMemoryBindInfo.Buffer
create(long address, int capacity)
Create aVkSparseImageMemoryBindInfo.Buffer
instance at the specified memory.static VkSparseImageMemoryBindInfo
createSafe(long address)
static VkSparseImageMemoryBindInfo.Buffer
createSafe(long address, int capacity)
long
image()
Returns the value of theimage
field.VkSparseImageMemoryBindInfo
image(long value)
Sets the specified value to theimage
field.static VkSparseImageMemoryBindInfo
malloc()
Returns a newVkSparseImageMemoryBindInfo
instance allocated withmemAlloc
.static VkSparseImageMemoryBindInfo.Buffer
malloc(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated withmemAlloc
.static VkSparseImageMemoryBindInfo
mallocStack()
Returns a newVkSparseImageMemoryBindInfo
instance allocated on the thread-localMemoryStack
.static VkSparseImageMemoryBindInfo.Buffer
mallocStack(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkSparseImageMemoryBindInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkSparseImageMemoryBindInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo
instance allocated on the specifiedMemoryStack
.static int
nbindCount(long struct)
Unsafe version ofbindCount()
.static void
nbindCount(long struct, int value)
Sets the specified value to thebindCount
field of the specifiedstruct
.static long
nimage(long struct)
Unsafe version ofimage()
.static void
nimage(long struct, long value)
Unsafe version ofimage
.static VkSparseImageMemoryBind.Buffer
npBinds(long struct)
Unsafe version ofpBinds()
.static void
npBinds(long struct, VkSparseImageMemoryBind.Buffer value)
Unsafe version ofpBinds
.VkSparseImageMemoryBind.Buffer
pBinds()
Returns aVkSparseImageMemoryBind.Buffer
view of the struct array pointed to by thepBinds
field.VkSparseImageMemoryBindInfo
pBinds(VkSparseImageMemoryBind.Buffer value)
Sets the address of the specifiedVkSparseImageMemoryBind.Buffer
to thepBinds
field.VkSparseImageMemoryBindInfo
set(long image, VkSparseImageMemoryBind.Buffer pBinds)
Initializes this struct with the specified values.VkSparseImageMemoryBindInfo
set(VkSparseImageMemoryBindInfo src)
Copies the specified struct data to this struct.int
sizeof()
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
-
VkSparseImageMemoryBindInfo
public VkSparseImageMemoryBindInfo(java.nio.ByteBuffer container)
Creates aVkSparseImageMemoryBindInfo
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
-
image
public long image()
Returns the value of theimage
field.
-
bindCount
public int bindCount()
Returns the value of thebindCount
field.
-
pBinds
public VkSparseImageMemoryBind.Buffer pBinds()
Returns aVkSparseImageMemoryBind.Buffer
view of the struct array pointed to by thepBinds
field.
-
image
public VkSparseImageMemoryBindInfo image(long value)
Sets the specified value to theimage
field.
-
pBinds
public VkSparseImageMemoryBindInfo pBinds(VkSparseImageMemoryBind.Buffer value)
Sets the address of the specifiedVkSparseImageMemoryBind.Buffer
to thepBinds
field.
-
set
public VkSparseImageMemoryBindInfo set(long image, VkSparseImageMemoryBind.Buffer pBinds)
Initializes this struct with the specified values.
-
set
public VkSparseImageMemoryBindInfo set(VkSparseImageMemoryBindInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkSparseImageMemoryBindInfo malloc()
Returns a newVkSparseImageMemoryBindInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSparseImageMemoryBindInfo calloc()
Returns a newVkSparseImageMemoryBindInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSparseImageMemoryBindInfo create()
Returns a newVkSparseImageMemoryBindInfo
instance allocated withBufferUtils
.
-
create
public static VkSparseImageMemoryBindInfo create(long address)
Returns a newVkSparseImageMemoryBindInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkSparseImageMemoryBindInfo createSafe(long address)
-
malloc
public static VkSparseImageMemoryBindInfo.Buffer malloc(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSparseImageMemoryBindInfo.Buffer calloc(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseImageMemoryBindInfo.Buffer create(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseImageMemoryBindInfo.Buffer create(long address, int capacity)
Create aVkSparseImageMemoryBindInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkSparseImageMemoryBindInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSparseImageMemoryBindInfo mallocStack()
Returns a newVkSparseImageMemoryBindInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSparseImageMemoryBindInfo callocStack()
Returns a newVkSparseImageMemoryBindInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSparseImageMemoryBindInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSparseImageMemoryBindInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nimage
public static long nimage(long struct)
Unsafe version ofimage()
.
-
nbindCount
public static int nbindCount(long struct)
Unsafe version ofbindCount()
.
-
npBinds
public static VkSparseImageMemoryBind.Buffer npBinds(long struct)
Unsafe version ofpBinds()
.
-
nimage
public static void nimage(long struct, long value)
Unsafe version ofimage
.
-
nbindCount
public static void nbindCount(long struct, int value)
Sets the specified value to thebindCount
field of the specifiedstruct
.
-
npBinds
public static void npBinds(long struct, VkSparseImageMemoryBind.Buffer value)
Unsafe version ofpBinds
.
-
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
-
-