Structure specifying a sparse memory bind operation.

Description

The binding range [resourceOffset, resourceOffset + size) has different constraints based on flags. If flags contains SPARSE_MEMORY_BIND_METADATA_BIT, the binding range must be within the mip tail region of the metadata aspect. This metadata region is defined by:

metadataRegion = [base, base + imageMipTailSize)

base = imageMipTailOffset + imageMipTailStride × n

and imageMipTailOffset, imageMipTailSize, and imageMipTailStride values are from the VkSparseImageMemoryRequirements corresponding to the metadata aspect of the image, and n is a valid array layer index for the image,

imageMipTailStride is considered to be zero for aspects where VkSparseImageMemoryRequirements::formatProperties.flags contains SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT.

If flags does not contain SPARSE_MEMORY_BIND_METADATA_BIT, the binding range must be within the range [0,VkMemoryRequirements::size).

Valid Usage

If memory is not NULL_HANDLE, memory and memoryOffset must match the memory requirements of the resource, as described in section Resource Memory Association
If memory is not NULL_HANDLE, memory must not have been created with a memory type that reports MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT bit set
size must be greater than 0
resourceOffset must be less than the size of the resource
size must be less than or equal to the size of the resource minus resourceOffset
memoryOffset must be less than the size of memory
size must be less than or equal to the size of memory minus memoryOffset
If memory was created with VkExportMemoryAllocateInfo::handleTypes not equal to 0, at least one handle type it contained must also have been set in VkExternalMemoryBufferCreateInfo::handleTypes or VkExternalMemoryImageCreateInfo::handleTypes when the resource was created
If memory was created by a memory import operation, the external handle type of the imported memory must also have been set in VkExternalMemoryBufferCreateInfo::handleTypes or VkExternalMemoryImageCreateInfo::handleTypes when the resource was created

Valid Usage (Implicit)

If memory is not NULL_HANDLE, memory must be a valid VkDeviceMemory handle
flags must be a valid combination of VkSparseMemoryBindFlagBits values

Layout


struct VkSparseMemoryBind {
    VkDeviceSize resourceOffset;
    VkDeviceSize size;
    VkDeviceMemory memory;
    VkDeviceSize memoryOffset;
    VkSparseMemoryBindFlags flags;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkSparseMemoryBind.Buffer An array of `VkSparseMemoryBind` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FLAGS The struct member offsets.
public static final int	MEMORY The struct member offsets.
public static final int	MEMORYOFFSET The struct member offsets.
public static final int	RESOURCEOFFSET The struct member offsets.
public static final int	SIZE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkSparseMemoryBind(long address, ByteBuffer container)
public	VkSparseMemoryBind(ByteBuffer container) Creates a `VkSparseMemoryBind` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkSparseMemoryBind	calloc() Returns a new `VkSparseMemoryBind` instance allocated with `memCalloc`.
public static VkSparseMemoryBind.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `memCalloc`.
public static VkSparseMemoryBind	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSparseMemoryBind` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSparseMemoryBind.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSparseMemoryBind.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSparseMemoryBind	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSparseMemoryBind	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseMemoryBind.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseMemoryBind.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkSparseMemoryBind	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkSparseMemoryBind	create() Returns a new `VkSparseMemoryBind` instance allocated with `BufferUtils`.
public static VkSparseMemoryBind	create(long address) Returns a new `VkSparseMemoryBind` instance for the specified memory address.
public static VkSparseMemoryBind.Buffer	create(int the buffer capacity capacity) Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `BufferUtils`.
public static VkSparseMemoryBind.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSparseMemoryBind.Buffer` instance at the specified memory.
public static VkSparseMemoryBind	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSparseMemoryBind.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkSparseMemoryBindFlagBits` specifying usage of the binding operation.
public VkSparseMemoryBind	flags(int value) Sets the specified value to the `flags` field.
public static VkSparseMemoryBind	malloc() Returns a new `VkSparseMemoryBind` instance allocated with `memAlloc`.
public static VkSparseMemoryBind.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `memAlloc`.
public static VkSparseMemoryBind	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSparseMemoryBind` instance allocated on the specified `MemoryStack`.
public static VkSparseMemoryBind.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSparseMemoryBind.Buffer` instance allocated on the specified `MemoryStack`.
public static VkSparseMemoryBind	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSparseMemoryBind	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseMemoryBind.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseMemoryBind.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public long	memory() the `VkDeviceMemory` object that the range of the resource is bound to.
public VkSparseMemoryBind	memory(long value) Sets the specified value to the `memory` field.
public long	memoryOffset() the offset into the `VkDeviceMemory` object to bind the resource range to.
public VkSparseMemoryBind	memoryOffset(long value) Sets the specified value to the `memoryOffset` field.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static long	nmemory(long struct) Unsafe version of `memory`.
public static void	nmemory(long struct, long value) Unsafe version of `memory`.
public static long	nmemoryOffset(long struct) Unsafe version of `memoryOffset`.
public static void	nmemoryOffset(long struct, long value) Unsafe version of `memoryOffset`.
public static long	nresourceOffset(long struct) Unsafe version of `resourceOffset`.
public static void	nresourceOffset(long struct, long value) Unsafe version of `resourceOffset`.
public static long	nsize(long struct) Unsafe version of `size`.
public static void	nsize(long struct, long value) Unsafe version of `size`.
public long	resourceOffset() the offset into the resource.
public VkSparseMemoryBind	resourceOffset(long value) Sets the specified value to the `resourceOffset` field.
public VkSparseMemoryBind	set(long resourceOffset, long size, long memory, long memoryOffset, int flags) Initializes this struct with the specified values.
public VkSparseMemoryBind	Returns: this struct set(VkSparseMemoryBind the source struct src) Copies the specified struct data to this struct.
public long	size() the size of the memory region to be bound.
public VkSparseMemoryBind	size(long value) Sets the specified value to the `size` field.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

FLAGS	back to summary
public static final int FLAGS The struct member offsets.

MEMORY	back to summary
public static final int MEMORY The struct member offsets.

MEMORYOFFSET	back to summary
public static final int MEMORYOFFSET The struct member offsets.

RESOURCEOFFSET	back to summary
public static final int RESOURCEOFFSET The struct member offsets.

SIZE	back to summary
public static final int SIZE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkSparseMemoryBind	back to summary
protected VkSparseMemoryBind(long address, ByteBuffer container)

VkSparseMemoryBind back to summary

VkSparseMemoryBind	back to summary
public VkSparseMemoryBind(ByteBuffer container) Creates a `VkSparseMemoryBind` instance at the current position of the specified `ByteBuffer` 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.

public VkSparseMemoryBind(ByteBuffer container)

Creates a VkSparseMemoryBind instance at the current position of the specified ByteBuffer 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

calloc	back to summary
public static VkSparseMemoryBind calloc() Returns a new `VkSparseMemoryBind` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkSparseMemoryBind.Buffer calloc(int capacity) Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkSparseMemoryBind.Buffer calloc(int capacity)

Returns a new VkSparseMemoryBind.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkSparseMemoryBind calloc(MemoryStack stack) Returns a new `VkSparseMemoryBind` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkSparseMemoryBind calloc(MemoryStack stack)

Returns a new VkSparseMemoryBind instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkSparseMemoryBind.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkSparseMemoryBind.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkSparseMemoryBind.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSparseMemoryBind.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static VkSparseMemoryBind callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSparseMemoryBind callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkSparseMemoryBind callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSparseMemoryBind callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkSparseMemoryBind.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSparseMemoryBind.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkSparseMemoryBind.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSparseMemoryBind.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkSparseMemoryBind create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkSparseMemoryBind create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkSparseMemoryBind create() Returns a new `VkSparseMemoryBind` instance allocated with `BufferUtils`.

create	back to summary
public static VkSparseMemoryBind create(long address) Returns a new `VkSparseMemoryBind` instance for the specified memory address.

create back to summary

create	back to summary
public static VkSparseMemoryBind.Buffer create(int capacity) Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkSparseMemoryBind.Buffer create(int capacity)

Returns a new VkSparseMemoryBind.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkSparseMemoryBind.Buffer create(long address, int capacity) Create a `VkSparseMemoryBind.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkSparseMemoryBind.Buffer create(long address, int capacity)

Create a VkSparseMemoryBind.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkSparseMemoryBind createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkSparseMemoryBind createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkSparseMemoryBind.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkSparseMemoryBind.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

flags back to summary

flags	back to summary
public int flags() a bitmask of `VkSparseMemoryBindFlagBits` specifying usage of the binding operation. Annotations @NativeType:VkSparseMemoryBindFlags

public int flags()

a bitmask of VkSparseMemoryBindFlagBits specifying usage of the binding operation.

Annotations

@NativeType:VkSparseMemoryBindFlags

flags	back to summary
public VkSparseMemoryBind flags(int value) Sets the specified value to the `flags` field.

malloc	back to summary
public static VkSparseMemoryBind malloc() Returns a new `VkSparseMemoryBind` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkSparseMemoryBind.Buffer malloc(int capacity) Returns a new `VkSparseMemoryBind.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkSparseMemoryBind.Buffer malloc(int capacity)

Returns a new VkSparseMemoryBind.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkSparseMemoryBind malloc(MemoryStack stack) Returns a new `VkSparseMemoryBind` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkSparseMemoryBind malloc(MemoryStack stack)

Returns a new VkSparseMemoryBind instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkSparseMemoryBind.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkSparseMemoryBind.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkSparseMemoryBind.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkSparseMemoryBind.Buffer instance allocated on the specified MemoryStack.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkSparseMemoryBind mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSparseMemoryBind mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkSparseMemoryBind mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSparseMemoryBind mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkSparseMemoryBind.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSparseMemoryBind.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkSparseMemoryBind.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSparseMemoryBind.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

memory back to summary

memory	back to summary
public long memory() the `VkDeviceMemory` object that the range of the resource is bound to. If `memory` is `NULL_HANDLE`, the range is unbound. Annotations @NativeType:VkDeviceMemory

public long memory()

the VkDeviceMemory object that the range of the resource is bound to. If memory is NULL_HANDLE, the range is unbound.

Annotations

@NativeType:VkDeviceMemory

memory	back to summary
public VkSparseMemoryBind memory(long value) Sets the specified value to the `memory` field.

memoryOffset back to summary

memoryOffset	back to summary
public long memoryOffset() the offset into the `VkDeviceMemory` object to bind the resource range to. If `memory` is `NULL_HANDLE`, this value is ignored. Annotations @NativeType:VkDeviceSize

public long memoryOffset()

the offset into the VkDeviceMemory object to bind the resource range to. If memory is NULL_HANDLE, this value is ignored.

Annotations

@NativeType:VkDeviceSize

memoryOffset	back to summary
public VkSparseMemoryBind memoryOffset(long value) Sets the specified value to the `memoryOffset` field.

nflags	back to summary
public static int nflags(long struct) Unsafe version of `flags`.

nflags	back to summary
public static void nflags(long struct, int value) Unsafe version of `flags`.

nmemory	back to summary
public static long nmemory(long struct) Unsafe version of `memory`.

nmemory	back to summary
public static void nmemory(long struct, long value) Unsafe version of `memory`.

nmemoryOffset	back to summary
public static long nmemoryOffset(long struct) Unsafe version of `memoryOffset`.

nmemoryOffset	back to summary
public static void nmemoryOffset(long struct, long value) Unsafe version of `memoryOffset`.

nresourceOffset	back to summary
public static long nresourceOffset(long struct) Unsafe version of `resourceOffset`.

nresourceOffset	back to summary
public static void nresourceOffset(long struct, long value) Unsafe version of `resourceOffset`.

nsize	back to summary
public static long nsize(long struct) Unsafe version of `size`.

nsize	back to summary
public static void nsize(long struct, long value) Unsafe version of `size`.

resourceOffset

back to summary

public long resourceOffset()

the offset into the resource.

Annotations

@NativeType:VkDeviceSize

resourceOffset	back to summary
public VkSparseMemoryBind resourceOffset(long value) Sets the specified value to the `resourceOffset` field.

set	back to summary
public VkSparseMemoryBind set(long resourceOffset, long size, long memory, long memoryOffset, int flags) Initializes this struct with the specified values.

set

back to summary

public VkSparseMemoryBind set(VkSparseMemoryBind src)

Copies the specified struct data to this struct.

Parameters

src:VkSparseMemoryBind: the source struct

Returns:VkSparseMemoryBind

this struct

size

back to summary

public long size()

the size of the memory region to be bound.

Annotations

@NativeType:VkDeviceSize

size	back to summary
public VkSparseMemoryBind size(long value) Sets the specified value to the `size` field.

sizeof back to summary

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.vulkan back to summary

public Class VkSparseMemoryBind.Buffer

Class Inheritance

extends StructBuffer<VkSparseMemoryBind, VkSparseMemoryBind.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkSparseMemoryBind.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkSparseMemoryBind structs.

Field Summary

Modifier and Type	Field and Description
private static final VkSparseMemoryBind	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkSparseMemoryBind.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value of the `VkSparseMemoryBind#flags` field. flags()
public VkSparseMemoryBind.Buffer	flags(int value) Sets the specified value to the `VkSparseMemoryBind#flags` field.
protected VkSparseMemoryBind	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkSparseMemoryBind#memory` field. memory()
public VkSparseMemoryBind.Buffer	memory(long value) Sets the specified value to the `VkSparseMemoryBind#memory` field.
public long	Returns: the value of the `VkSparseMemoryBind#memoryOffset` field. memoryOffset()
public VkSparseMemoryBind.Buffer	memoryOffset(long value) Sets the specified value to the `VkSparseMemoryBind#memoryOffset` field.
public long	Returns: the value of the `VkSparseMemoryBind#resourceOffset` field. resourceOffset()
public VkSparseMemoryBind.Buffer	resourceOffset(long value) Sets the specified value to the `VkSparseMemoryBind#resourceOffset` field.
protected VkSparseMemoryBind.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `VkSparseMemoryBind#size` field. size()
public VkSparseMemoryBind.Buffer	size(long value) Sets the specified value to the `VkSparseMemoryBind#size` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkSparseMemoryBind ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkSparseMemoryBind.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSparseMemoryBind#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flags	back to summary
public int flags() Returns:int the value of the `VkSparseMemoryBind#flags` field. Annotations @NativeType:VkSparseMemoryBindFlags

flags	back to summary
public VkSparseMemoryBind.Buffer flags(int value) Sets the specified value to the `VkSparseMemoryBind#flags` field.

getElementFactory

back to summary

protected VkSparseMemoryBind getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

memory	back to summary
public long memory() Returns:long the value of the `VkSparseMemoryBind#memory` field. Annotations @NativeType:VkDeviceMemory

memory	back to summary
public VkSparseMemoryBind.Buffer memory(long value) Sets the specified value to the `VkSparseMemoryBind#memory` field.

memoryOffset	back to summary
public long memoryOffset() Returns:long the value of the `VkSparseMemoryBind#memoryOffset` field. Annotations @NativeType:VkDeviceSize

memoryOffset	back to summary
public VkSparseMemoryBind.Buffer memoryOffset(long value) Sets the specified value to the `VkSparseMemoryBind#memoryOffset` field.

resourceOffset	back to summary
public long resourceOffset() Returns:long the value of the `VkSparseMemoryBind#resourceOffset` field. Annotations @NativeType:VkDeviceSize

resourceOffset	back to summary
public VkSparseMemoryBind.Buffer resourceOffset(long value) Sets the specified value to the `VkSparseMemoryBind#resourceOffset` field.

self

back to summary

protected VkSparseMemoryBind.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

size	back to summary
public long size() Returns:long the value of the `VkSparseMemoryBind#size` field. Annotations @NativeType:VkDeviceSize

size	back to summary
public VkSparseMemoryBind.Buffer size(long value) Sets the specified value to the `VkSparseMemoryBind#size` field.

public Class VkSparseMemoryBind

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkSparseMemoryBind.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail