Package org.lwjgl.vulkan
Class VkSparseImageOpaqueMemoryBindInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSparseImageOpaqueMemoryBindInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkSparseImageOpaqueMemoryBindInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying sparse image opaque memory bind info.Valid Usage
- If the
flags
member of any element ofpBinds
containsSPARSE_MEMORY_BIND_METADATA_BIT
, the binding range defined must be within the mip tail region of the metadata aspect ofimage
Valid Usage (Implicit)
image
must be a validVkImage
handlepBinds
must be a valid pointer to an array ofbindCount
validVkSparseMemoryBind
structuresbindCount
must be greater than 0
See Also
VkBindSparseInfo
,VkSparseMemoryBind
Member documentation
image
– theVkImage
object to be bound.bindCount
– the number ofVkSparseMemoryBind
structures in thepBinds
array.pBinds
– a pointer to array ofVkSparseMemoryBind
structures.
Layout
struct VkSparseImageOpaqueMemoryBindInfo { VkImage image; uint32_t bindCount;
VkSparseMemoryBind
const * pBinds; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkSparseImageOpaqueMemoryBindInfo.Buffer
An array ofVkSparseImageOpaqueMemoryBindInfo
structs.
-
Constructor Summary
Constructors Constructor Description VkSparseImageOpaqueMemoryBindInfo(java.nio.ByteBuffer container)
Creates aVkSparseImageOpaqueMemoryBindInfo
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 VkSparseImageOpaqueMemoryBindInfo
calloc()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated withmemCalloc
.static VkSparseImageOpaqueMemoryBindInfo.Buffer
calloc(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated withmemCalloc
.static VkSparseImageOpaqueMemoryBindInfo
callocStack()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseImageOpaqueMemoryBindInfo.Buffer
callocStack(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseImageOpaqueMemoryBindInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageOpaqueMemoryBindInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageOpaqueMemoryBindInfo
create()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated withBufferUtils
.static VkSparseImageOpaqueMemoryBindInfo.Buffer
create(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated withBufferUtils
.static VkSparseImageOpaqueMemoryBindInfo
create(long address)
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance for the specified memory address.static VkSparseImageOpaqueMemoryBindInfo.Buffer
create(long address, int capacity)
Create aVkSparseImageOpaqueMemoryBindInfo.Buffer
instance at the specified memory.static VkSparseImageOpaqueMemoryBindInfo
createSafe(long address)
static VkSparseImageOpaqueMemoryBindInfo.Buffer
createSafe(long address, int capacity)
long
image()
Returns the value of theimage
field.VkSparseImageOpaqueMemoryBindInfo
image(long value)
Sets the specified value to theimage
field.static VkSparseImageOpaqueMemoryBindInfo
malloc()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated withmemAlloc
.static VkSparseImageOpaqueMemoryBindInfo.Buffer
malloc(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated withmemAlloc
.static VkSparseImageOpaqueMemoryBindInfo
mallocStack()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated on the thread-localMemoryStack
.static VkSparseImageOpaqueMemoryBindInfo.Buffer
mallocStack(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkSparseImageOpaqueMemoryBindInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkSparseImageOpaqueMemoryBindInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageOpaqueMemoryBindInfo
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 VkSparseMemoryBind.Buffer
npBinds(long struct)
Unsafe version ofpBinds()
.static void
npBinds(long struct, VkSparseMemoryBind.Buffer value)
Unsafe version ofpBinds
.VkSparseMemoryBind.Buffer
pBinds()
Returns aVkSparseMemoryBind.Buffer
view of the struct array pointed to by thepBinds
field.VkSparseImageOpaqueMemoryBindInfo
pBinds(VkSparseMemoryBind.Buffer value)
Sets the address of the specifiedVkSparseMemoryBind.Buffer
to thepBinds
field.VkSparseImageOpaqueMemoryBindInfo
set(long image, VkSparseMemoryBind.Buffer pBinds)
Initializes this struct with the specified values.VkSparseImageOpaqueMemoryBindInfo
set(VkSparseImageOpaqueMemoryBindInfo 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
-
VkSparseImageOpaqueMemoryBindInfo
public VkSparseImageOpaqueMemoryBindInfo(java.nio.ByteBuffer container)
Creates aVkSparseImageOpaqueMemoryBindInfo
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 VkSparseMemoryBind.Buffer pBinds()
Returns aVkSparseMemoryBind.Buffer
view of the struct array pointed to by thepBinds
field.
-
image
public VkSparseImageOpaqueMemoryBindInfo image(long value)
Sets the specified value to theimage
field.
-
pBinds
public VkSparseImageOpaqueMemoryBindInfo pBinds(VkSparseMemoryBind.Buffer value)
Sets the address of the specifiedVkSparseMemoryBind.Buffer
to thepBinds
field.
-
set
public VkSparseImageOpaqueMemoryBindInfo set(long image, VkSparseMemoryBind.Buffer pBinds)
Initializes this struct with the specified values.
-
set
public VkSparseImageOpaqueMemoryBindInfo set(VkSparseImageOpaqueMemoryBindInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkSparseImageOpaqueMemoryBindInfo malloc()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSparseImageOpaqueMemoryBindInfo calloc()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSparseImageOpaqueMemoryBindInfo create()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated withBufferUtils
.
-
create
public static VkSparseImageOpaqueMemoryBindInfo create(long address)
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkSparseImageOpaqueMemoryBindInfo createSafe(long address)
-
malloc
public static VkSparseImageOpaqueMemoryBindInfo.Buffer malloc(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSparseImageOpaqueMemoryBindInfo.Buffer calloc(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseImageOpaqueMemoryBindInfo.Buffer create(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseImageOpaqueMemoryBindInfo.Buffer create(long address, int capacity)
Create aVkSparseImageOpaqueMemoryBindInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkSparseImageOpaqueMemoryBindInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSparseImageOpaqueMemoryBindInfo mallocStack()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSparseImageOpaqueMemoryBindInfo callocStack()
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSparseImageOpaqueMemoryBindInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSparseImageOpaqueMemoryBindInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageOpaqueMemoryBindInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkSparseImageOpaqueMemoryBindInfo.Buffer mallocStack(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSparseImageOpaqueMemoryBindInfo.Buffer callocStack(int capacity)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSparseImageOpaqueMemoryBindInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageOpaqueMemoryBindInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkSparseImageOpaqueMemoryBindInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageOpaqueMemoryBindInfo.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 VkSparseMemoryBind.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, VkSparseMemoryBind.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
-
-