Structure specifying sparse image memory bind.

Valid Usage

If the sparseResidencyAliased feature is not enabled, and if any other resources are bound to ranges of memory, the range of memory being bound must not overlap with those bound ranges
memory and memoryOffset must match the memory requirements of the calling command’s image, as described in section Resource Memory Association
subresource must be a valid image subresource for image (see Image Views)
offset.x must be a multiple of the sparse image block width (VkSparseImageFormatProperties::imageGranularity.width) of the image
extent.width must either be a multiple of the sparse image block width of the image, or else (extent.width + offset.x) must equal the width of the image subresource
offset.y must be a multiple of the sparse image block height (VkSparseImageFormatProperties::imageGranularity.height) of the image
extent.height must either be a multiple of the sparse image block height of the image, or else (extent.height + offset.y) must equal the height of the image subresource
offset.z must be a multiple of the sparse image block depth (VkSparseImageFormatProperties::imageGranularity.depth) of the image
extent.depth must either be a multiple of the sparse image block depth of the image, or else (extent.depth + offset.z) must equal the depth of the image subresource
If memory was created with VkExportMemoryAllocateInfo::handleTypes not equal to 0, at least one handle type it contained must also have been set in VkExternalMemoryImageCreateInfo::handleTypes when the image 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 VkExternalMemoryImageCreateInfo::handleTypes when image was created

Valid Usage (Implicit)

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

Layout


struct VkSparseImageMemoryBind {
    VkImageSubresource subresource;
    VkOffset3D offset;
    VkExtent3D extent;
    VkDeviceMemory memory;
    VkDeviceSize memoryOffset;
    VkSparseMemoryBindFlags flags;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	EXTENT The struct member offsets.
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	OFFSET The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SUBRESOURCE The struct member offsets.

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public static VkSparseImageMemoryBind	calloc() Returns a new `VkSparseImageMemoryBind` instance allocated with `memCalloc`.
public static VkSparseImageMemoryBind.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated with `memCalloc`.
public static VkSparseImageMemoryBind	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSparseImageMemoryBind` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSparseImageMemoryBind.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSparseImageMemoryBind	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBind	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBind.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBind.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkSparseImageMemoryBind	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 VkSparseImageMemoryBind	create() Returns a new `VkSparseImageMemoryBind` instance allocated with `BufferUtils`.
public static VkSparseImageMemoryBind	create(long address) Returns a new `VkSparseImageMemoryBind` instance for the specified memory address.
public static VkSparseImageMemoryBind.Buffer	create(int the buffer capacity capacity) Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated with `BufferUtils`.
public static VkSparseImageMemoryBind.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSparseImageMemoryBind.Buffer` instance at the specified memory.
public static VkSparseImageMemoryBind	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSparseImageMemoryBind.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public VkExtent3D	extent() the size in texels of the region within the image subresource to bind.
public VkSparseImageMemoryBind	extent(VkExtent3D value) Copies the specified `VkExtent3D` to the `extent` field.
public VkSparseImageMemoryBind	extent(Consumer<VkExtent3D> consumer) Passes the `extent` field to the specified `Consumer`.
public int	flags() are sparse memory binding flags.
public VkSparseImageMemoryBind	flags(int value) Sets the specified value to the `flags` field.
public static VkSparseImageMemoryBind	malloc() Returns a new `VkSparseImageMemoryBind` instance allocated with `memAlloc`.
public static VkSparseImageMemoryBind.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated with `memAlloc`.
public static VkSparseImageMemoryBind	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSparseImageMemoryBind` instance allocated on the specified `MemoryStack`.
public static VkSparseImageMemoryBind.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated on the specified `MemoryStack`.
public static VkSparseImageMemoryBind	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBind	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBind.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBind.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public long	memory() the `VkDeviceMemory` object that the sparse image blocks of the image are bound to.
public VkSparseImageMemoryBind	memory(long value) Sets the specified value to the `memory` field.
public long	memoryOffset() an offset into `VkDeviceMemory` object.
public VkSparseImageMemoryBind	memoryOffset(long value) Sets the specified value to the `memoryOffset` field.
public static VkExtent3D	nextent(long struct) Unsafe version of `extent`.
public static void	nextent(long struct, VkExtent3D value) Unsafe version of `extent`.
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 VkOffset3D	noffset(long struct) Unsafe version of `offset`.
public static void	noffset(long struct, VkOffset3D value) Unsafe version of `offset`.
public static VkImageSubresource	nsubresource(long struct) Unsafe version of `subresource`.
public static void	nsubresource(long struct, VkImageSubresource value) Unsafe version of `subresource`.
public VkOffset3D	offset() are the coordinates of the first texel within the image subresource to bind.
public VkSparseImageMemoryBind	offset(VkOffset3D value) Copies the specified `VkOffset3D` to the `offset` field.
public VkSparseImageMemoryBind	offset(Consumer<VkOffset3D> consumer) Passes the `offset` field to the specified `Consumer`.
public VkSparseImageMemoryBind	set(VkImageSubresource subresource, VkOffset3D offset, VkExtent3D extent, long memory, long memoryOffset, int flags) Initializes this struct with the specified values.
public VkSparseImageMemoryBind	Returns: this struct set(VkSparseImageMemoryBind the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public VkImageSubresource	subresource() the image aspect and region of interest in the image.
public VkSparseImageMemoryBind	subresource(VkImageSubresource value) Copies the specified `VkImageSubresource` to the `subresource` field.
public VkSparseImageMemoryBind	subresource(Consumer<VkImageSubresource> consumer) Passes the `subresource` field to the specified `Consumer`.

Field Detail

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

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

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.

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

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

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

Constructor Detail

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

VkSparseImageMemoryBind back to summary

VkSparseImageMemoryBind	back to summary
public VkSparseImageMemoryBind(ByteBuffer container) Creates a `VkSparseImageMemoryBind` 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 VkSparseImageMemoryBind(ByteBuffer container)

Creates a VkSparseImageMemoryBind 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 VkSparseImageMemoryBind calloc() Returns a new `VkSparseImageMemoryBind` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static VkSparseImageMemoryBind.Buffer calloc(int capacity)

Returns a new VkSparseImageMemoryBind.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 VkSparseImageMemoryBind calloc(MemoryStack stack) Returns a new `VkSparseImageMemoryBind` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkSparseImageMemoryBind calloc(MemoryStack stack)

Returns a new VkSparseImageMemoryBind 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 VkSparseImageMemoryBind.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkSparseImageMemoryBind.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 VkSparseImageMemoryBind.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSparseImageMemoryBind.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 VkSparseImageMemoryBind callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSparseImageMemoryBind 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 VkSparseImageMemoryBind callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSparseImageMemoryBind 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 VkSparseImageMemoryBind.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSparseImageMemoryBind.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 VkSparseImageMemoryBind.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSparseImageMemoryBind.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 VkSparseImageMemoryBind 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 VkSparseImageMemoryBind 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 VkSparseImageMemoryBind create() Returns a new `VkSparseImageMemoryBind` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkSparseImageMemoryBind.Buffer create(int capacity)

Returns a new VkSparseImageMemoryBind.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkSparseImageMemoryBind.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 VkSparseImageMemoryBind createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkSparseImageMemoryBind createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

extent	back to summary
public VkExtent3D extent() the size in texels of the region within the image subresource to bind. The extent must be a multiple of the sparse image block dimensions, except when binding sparse image blocks along the edge of an image subresource it can instead be such that any coordinate of `offset + extent` equals the corresponding dimensions of the image subresource.

extent	back to summary
public VkSparseImageMemoryBind extent(VkExtent3D value) Copies the specified `VkExtent3D` to the `extent` field.

extent	back to summary
public VkSparseImageMemoryBind extent(Consumer<VkExtent3D> consumer) Passes the `extent` field to the specified `Consumer`.

flags	back to summary
public int flags() are sparse memory binding flags. Annotations @NativeType:VkSparseMemoryBindFlags

flags

back to summary

public int flags()

are sparse memory binding flags.

Annotations

@NativeType:VkSparseMemoryBindFlags

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

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

malloc back to summary

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

public static VkSparseImageMemoryBind.Buffer malloc(int capacity)

Returns a new VkSparseImageMemoryBind.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 VkSparseImageMemoryBind malloc(MemoryStack stack) Returns a new `VkSparseImageMemoryBind` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkSparseImageMemoryBind malloc(MemoryStack stack)

Returns a new VkSparseImageMemoryBind 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 VkSparseImageMemoryBind.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkSparseImageMemoryBind.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

Returns a new VkSparseImageMemoryBind.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 VkSparseImageMemoryBind mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSparseImageMemoryBind 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 VkSparseImageMemoryBind mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSparseImageMemoryBind 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 VkSparseImageMemoryBind.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSparseImageMemoryBind.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 VkSparseImageMemoryBind.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSparseImageMemoryBind.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 sparse image blocks of the image are bound to. If `memory` is `NULL_HANDLE`, the sparse image blocks are unbound. Annotations @NativeType:VkDeviceMemory

public long memory()

the VkDeviceMemory object that the sparse image blocks of the image are bound to. If memory is NULL_HANDLE, the sparse image blocks are unbound.

Annotations

@NativeType:VkDeviceMemory

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

memoryOffset back to summary

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

public long memoryOffset()

an offset into VkDeviceMemory object. If memory is NULL_HANDLE, this value is ignored.

Annotations

@NativeType:VkDeviceSize

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

nextent	back to summary
public static VkExtent3D nextent(long struct) Unsafe version of `extent`.

nextent	back to summary
public static void nextent(long struct, VkExtent3D value) Unsafe version of `extent`.

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`.

noffset	back to summary
public static VkOffset3D noffset(long struct) Unsafe version of `offset`.

noffset	back to summary
public static void noffset(long struct, VkOffset3D value) Unsafe version of `offset`.

nsubresource	back to summary
public static VkImageSubresource nsubresource(long struct) Unsafe version of `subresource`.

nsubresource	back to summary
public static void nsubresource(long struct, VkImageSubresource value) Unsafe version of `subresource`.

offset	back to summary
public VkOffset3D offset() are the coordinates of the first texel within the image subresource to bind.

offset	back to summary
public VkSparseImageMemoryBind offset(VkOffset3D value) Copies the specified `VkOffset3D` to the `offset` field.

offset	back to summary
public VkSparseImageMemoryBind offset(Consumer<VkOffset3D> consumer) Passes the `offset` field to the specified `Consumer`.

set	back to summary
public VkSparseImageMemoryBind set(VkImageSubresource subresource, VkOffset3D offset, VkExtent3D extent, long memory, long memoryOffset, int flags) Initializes this struct with the specified values.

set

back to summary

public VkSparseImageMemoryBind set(VkSparseImageMemoryBind src)

Copies the specified struct data to this struct.

Parameters

src:VkSparseImageMemoryBind: the source struct

Returns:VkSparseImageMemoryBind

this struct

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

subresource	back to summary
public VkImageSubresource subresource() the image aspect and region of interest in the image.

subresource	back to summary
public VkSparseImageMemoryBind subresource(VkImageSubresource value) Copies the specified `VkImageSubresource` to the `subresource` field.

subresource	back to summary
public VkSparseImageMemoryBind subresource(Consumer<VkImageSubresource> consumer) Passes the `subresource` field to the specified `Consumer`.

org.lwjgl.vulkan back to summary

public Class VkSparseImageMemoryBind.Buffer

Class Inheritance

extends StructBuffer<VkSparseImageMemoryBind, VkSparseImageMemoryBind.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkSparseImageMemoryBind structs.

Field Summary

Modifier and Type	Field and Description
private static final VkSparseImageMemoryBind	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkSparseImageMemoryBind.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 VkExtent3D	Returns: a `VkExtent3D` view of the `VkSparseImageMemoryBind#extent` field. extent()
public VkSparseImageMemoryBind.Buffer	extent(VkExtent3D value) Copies the specified `VkExtent3D` to the `VkSparseImageMemoryBind#extent` field.
public VkSparseImageMemoryBind.Buffer	extent(Consumer<VkExtent3D> consumer) Passes the `VkSparseImageMemoryBind#extent` field to the specified `Consumer`.
public int	Returns: the value of the `VkSparseImageMemoryBind#flags` field. flags()
public VkSparseImageMemoryBind.Buffer	flags(int value) Sets the specified value to the `VkSparseImageMemoryBind#flags` field.
protected VkSparseImageMemoryBind	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkSparseImageMemoryBind#memory` field. memory()
public VkSparseImageMemoryBind.Buffer	memory(long value) Sets the specified value to the `VkSparseImageMemoryBind#memory` field.
public long	Returns: the value of the `VkSparseImageMemoryBind#memoryOffset` field. memoryOffset()
public VkSparseImageMemoryBind.Buffer	memoryOffset(long value) Sets the specified value to the `VkSparseImageMemoryBind#memoryOffset` field.
public VkOffset3D	Returns: a `VkOffset3D` view of the `VkSparseImageMemoryBind#offset` field. offset()
public VkSparseImageMemoryBind.Buffer	offset(VkOffset3D value) Copies the specified `VkOffset3D` to the `VkSparseImageMemoryBind#offset` field.
public VkSparseImageMemoryBind.Buffer	offset(Consumer<VkOffset3D> consumer) Passes the `VkSparseImageMemoryBind#offset` field to the specified `Consumer`.
protected VkSparseImageMemoryBind.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public VkImageSubresource	Returns: a `VkImageSubresource` view of the `VkSparseImageMemoryBind#subresource` field. subresource()
public VkSparseImageMemoryBind.Buffer	subresource(VkImageSubresource value) Copies the specified `VkImageSubresource` to the `VkSparseImageMemoryBind#subresource` field.
public VkSparseImageMemoryBind.Buffer	subresource(Consumer<VkImageSubresource> consumer) Passes the `VkSparseImageMemoryBind#subresource` field to the specified `Consumer`.

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 VkSparseImageMemoryBind ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkSparseImageMemoryBind.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 VkSparseImageMemoryBind#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

extent	back to summary
public VkExtent3D extent() Returns:VkExtent3D a `VkExtent3D` view of the `VkSparseImageMemoryBind#extent` field.

extent	back to summary
public VkSparseImageMemoryBind.Buffer extent(VkExtent3D value) Copies the specified `VkExtent3D` to the `VkSparseImageMemoryBind#extent` field.

extent	back to summary
public VkSparseImageMemoryBind.Buffer extent(Consumer<VkExtent3D> consumer) Passes the `VkSparseImageMemoryBind#extent` field to the specified `Consumer`.

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

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

getElementFactory

back to summary

protected VkSparseImageMemoryBind getElementFactory()

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

Annotations

@Override

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

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

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

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

offset	back to summary
public VkOffset3D offset() Returns:VkOffset3D a `VkOffset3D` view of the `VkSparseImageMemoryBind#offset` field.

offset	back to summary
public VkSparseImageMemoryBind.Buffer offset(VkOffset3D value) Copies the specified `VkOffset3D` to the `VkSparseImageMemoryBind#offset` field.

offset	back to summary
public VkSparseImageMemoryBind.Buffer offset(Consumer<VkOffset3D> consumer) Passes the `VkSparseImageMemoryBind#offset` field to the specified `Consumer`.

self

back to summary

protected VkSparseImageMemoryBind.Buffer self()

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

Annotations

@Override

subresource	back to summary
public VkImageSubresource subresource() Returns:VkImageSubresource a `VkImageSubresource` view of the `VkSparseImageMemoryBind#subresource` field.

subresource	back to summary
public VkSparseImageMemoryBind.Buffer subresource(VkImageSubresource value) Copies the specified `VkImageSubresource` to the `VkSparseImageMemoryBind#subresource` field.

subresource	back to summary
public VkSparseImageMemoryBind.Buffer subresource(Consumer<VkImageSubresource> consumer) Passes the `VkSparseImageMemoryBind#subresource` field to the specified `Consumer`.

public Class VkSparseImageMemoryBind

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 VkSparseImageMemoryBind.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail