Structure specifying device within a group to bind to.

Description

If the pNext chain of VkBindImageMemoryInfo includes a VkBindImageMemoryDeviceGroupInfo structure, then that structure determines how memory is bound to images across multiple devices in a device group.

If deviceIndexCount is greater than zero, then on device index i image is attached to the instance of the memory on the physical device with device index pDeviceIndices[i].

Let N be the number of physical devices in the logical device. If splitInstanceBindRegionCount is greater than zero, then pSplitInstanceBindRegions is a pointer to an array of N² rectangles, where the image region specified by the rectangle at element i*N+j in resource instance i is bound to the memory instance j. The blocks of the memory that are bound to each sparse image block region use an offset in memory, relative to memoryOffset, computed as if the whole image was being bound to a contiguous range of memory. In other words, horizontally adjacent image blocks use consecutive blocks of memory, vertically adjacent image blocks are separated by the number of bytes per block multiplied by the width in blocks of image, and the block at (0,0) corresponds to memory starting at memoryOffset.

If splitInstanceBindRegionCount and deviceIndexCount are zero and the memory comes from a memory heap with the MEMORY_HEAP_MULTI_INSTANCE_BIT bit set, then it is as if pDeviceIndices contains consecutive indices from zero to the number of physical devices in the logical device, minus one. In other words, by default each physical device attaches to its own instance of the memory.

If splitInstanceBindRegionCount and deviceIndexCount are zero and the memory comes from a memory heap without the MEMORY_HEAP_MULTI_INSTANCE_BIT bit set, then it is as if pDeviceIndices contains an array of zeros. In other words, by default each physical device attaches to instance zero.

Valid Usage

At least one of deviceIndexCount and splitInstanceBindRegionCount must be zero
deviceIndexCount must either be zero or equal to the number of physical devices in the logical device
All elements of pDeviceIndices must be valid device indices
splitInstanceBindRegionCount must either be zero or equal to the number of physical devices in the logical device squared
Elements of pSplitInstanceBindRegions that correspond to the same instance of an image must not overlap
The offset.x member of any element of pSplitInstanceBindRegions must be a multiple of the sparse image block width (VkSparseImageFormatProperties::imageGranularity.width) of all non-metadata aspects of the image
The offset.y member of any element of pSplitInstanceBindRegions must be a multiple of the sparse image block height (VkSparseImageFormatProperties::imageGranularity.height) of all non-metadata aspects of the image
The extent.width member of any element of pSplitInstanceBindRegions must either be a multiple of the sparse image block width of all non-metadata aspects of the image, or else extent.width + offset.x must equal the width of the image subresource
The extent.height member of any element of pSplitInstanceBindRegions must either be a multiple of the sparse image block height of all non-metadata aspects of the image, or else extent.height + offset.y must equal the height of the image subresource

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO
If deviceIndexCount is not 0, pDeviceIndices must be a valid pointer to an array of deviceIndexCount uint32_t values
If splitInstanceBindRegionCount is not 0, pSplitInstanceBindRegions must be a valid pointer to an array of splitInstanceBindRegionCount VkRect2D structures

Layout


struct VkBindImageMemoryDeviceGroupInfo {
    VkStructureType sType;
    void const * pNext;
    uint32_t deviceIndexCount;
    uint32_t const * pDeviceIndices;
    uint32_t splitInstanceBindRegionCount;
    VkRect2D const * pSplitInstanceBindRegions;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DEVICEINDEXCOUNT The struct member offsets.
public static final int	PDEVICEINDICES The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	PSPLITINSTANCEBINDREGIONS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SPLITINSTANCEBINDREGIONCOUNT The struct member offsets.
public static final int	STYPE The struct member offsets.

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public static VkBindImageMemoryDeviceGroupInfo	calloc() Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated with `memCalloc`.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated with `memCalloc`.
public static VkBindImageMemoryDeviceGroupInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkBindImageMemoryDeviceGroupInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkBindImageMemoryDeviceGroupInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkBindImageMemoryDeviceGroupInfo	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 VkBindImageMemoryDeviceGroupInfo	create() Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated with `BufferUtils`.
public static VkBindImageMemoryDeviceGroupInfo	create(long address) Returns a new `VkBindImageMemoryDeviceGroupInfo` instance for the specified memory address.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated with `BufferUtils`.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkBindImageMemoryDeviceGroupInfo.Buffer` instance at the specified memory.
public static VkBindImageMemoryDeviceGroupInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	deviceIndexCount() the number of elements in `pDeviceIndices`.
public static VkBindImageMemoryDeviceGroupInfo	malloc() Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated with `memAlloc`.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated with `memAlloc`.
public static VkBindImageMemoryDeviceGroupInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkBindImageMemoryDeviceGroupInfo` instance allocated on the specified `MemoryStack`.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkBindImageMemoryDeviceGroupInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VkBindImageMemoryDeviceGroupInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkBindImageMemoryDeviceGroupInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkBindImageMemoryDeviceGroupInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	ndeviceIndexCount(long struct) Unsafe version of `deviceIndexCount`.
public static void	ndeviceIndexCount(long struct, int value) Sets the specified value to the `deviceIndexCount` field of the specified `struct`.
public static IntBuffer	npDeviceIndices(long struct) Unsafe version of `pDeviceIndices`.
public static void	npDeviceIndices(long struct, IntBuffer value) Unsafe version of `pDeviceIndices`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static VkRect2D.Buffer	npSplitInstanceBindRegions(long struct) Unsafe version of `pSplitInstanceBindRegions`.
public static void	npSplitInstanceBindRegions(long struct, VkRect2D.Buffer value) Unsafe version of `pSplitInstanceBindRegions`.
public static int	nsplitInstanceBindRegionCount(long struct) Unsafe version of `splitInstanceBindRegionCount`.
public static void	nsplitInstanceBindRegionCount(long struct, int value) Sets the specified value to the `splitInstanceBindRegionCount` field of the specified `struct`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public IntBuffer	pDeviceIndices() a pointer to an array of device indices.
public VkBindImageMemoryDeviceGroupInfo	pDeviceIndices(IntBuffer value) Sets the address of the specified `IntBuffer` to the `pDeviceIndices` field.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkBindImageMemoryDeviceGroupInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkRect2D.Buffer	pSplitInstanceBindRegions() a pointer to an array of `VkRect2D` structures describing which regions of the image are attached to each instance of memory.
public VkBindImageMemoryDeviceGroupInfo	pSplitInstanceBindRegions(VkRect2D.Buffer value) Sets the address of the specified `VkRect2D.Buffer` to the `pSplitInstanceBindRegions` field.
public VkBindImageMemoryDeviceGroupInfo	set(int sType, long pNext, IntBuffer pDeviceIndices, VkRect2D.Buffer pSplitInstanceBindRegions) Initializes this struct with the specified values.
public VkBindImageMemoryDeviceGroupInfo	Returns: this struct set(VkBindImageMemoryDeviceGroupInfo 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 int	splitInstanceBindRegionCount() the number of elements in `pSplitInstanceBindRegions`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkBindImageMemoryDeviceGroupInfo	sType(int value) Sets the specified value to the `sType` field.
public VkBindImageMemoryDeviceGroupInfo	sType$Default() Sets the `STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO` value to the `sType` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

Field Detail

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

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

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

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

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

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

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

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

Constructor Detail

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

VkBindImageMemoryDeviceGroupInfo back to summary

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

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

calloc back to summary

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

public static VkBindImageMemoryDeviceGroupInfo.Buffer calloc(int capacity)

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

public static VkBindImageMemoryDeviceGroupInfo calloc(MemoryStack stack)

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

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

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

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

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

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

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

create back to summary

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

public static VkBindImageMemoryDeviceGroupInfo.Buffer create(int capacity)

Returns a new VkBindImageMemoryDeviceGroupInfo.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static VkBindImageMemoryDeviceGroupInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

deviceIndexCount back to summary

deviceIndexCount	back to summary
public int deviceIndexCount() the number of elements in `pDeviceIndices`. Annotations @NativeType:uint32_t

public int deviceIndexCount()

the number of elements in pDeviceIndices.

Annotations

@NativeType:uint32_t

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

malloc back to summary

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

public static VkBindImageMemoryDeviceGroupInfo.Buffer malloc(int capacity)

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

public static VkBindImageMemoryDeviceGroupInfo malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

ndeviceIndexCount	back to summary
public static int ndeviceIndexCount(long struct) Unsafe version of `deviceIndexCount`.

ndeviceIndexCount	back to summary
public static void ndeviceIndexCount(long struct, int value) Sets the specified value to the `deviceIndexCount` field of the specified `struct`.

npDeviceIndices back to summary

npDeviceIndices	back to summary
public static IntBuffer npDeviceIndices(long struct) Unsafe version of `pDeviceIndices`. Annotations @Nullable

public static IntBuffer npDeviceIndices(long struct)

Unsafe version of pDeviceIndices.

Annotations

@Nullable

npDeviceIndices	back to summary
public static void npDeviceIndices(long struct, IntBuffer value) Unsafe version of `pDeviceIndices`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

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

npSplitInstanceBindRegions back to summary

npSplitInstanceBindRegions	back to summary
public static VkRect2D.Buffer npSplitInstanceBindRegions(long struct) Unsafe version of `pSplitInstanceBindRegions`. Annotations @Nullable

public static VkRect2D.Buffer npSplitInstanceBindRegions(long struct)

Unsafe version of pSplitInstanceBindRegions.

Annotations

@Nullable

npSplitInstanceBindRegions	back to summary
public static void npSplitInstanceBindRegions(long struct, VkRect2D.Buffer value) Unsafe version of `pSplitInstanceBindRegions`.

nsplitInstanceBindRegionCount	back to summary
public static int nsplitInstanceBindRegionCount(long struct) Unsafe version of `splitInstanceBindRegionCount`.

nsplitInstanceBindRegionCount	back to summary
public static void nsplitInstanceBindRegionCount(long struct, int value) Sets the specified value to the `splitInstanceBindRegionCount` field of the specified `struct`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

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

pDeviceIndices

back to summary

public IntBuffer pDeviceIndices()

a pointer to an array of device indices.

Annotations

@Nullable
@NativeType:uint32_t const *

pDeviceIndices	back to summary
public VkBindImageMemoryDeviceGroupInfo pDeviceIndices(IntBuffer value) Sets the address of the specified `IntBuffer` to the `pDeviceIndices` field.

pNext back to summary

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkBindImageMemoryDeviceGroupInfo pNext(long value) Sets the specified value to the `pNext` field.

pSplitInstanceBindRegions back to summary

public VkRect2D.Buffer pSplitInstanceBindRegions()

a pointer to an array of VkRect2D structures describing which regions of the image are attached to each instance of memory.

Annotations

@Nullable
@NativeType:VkRect2D const *

pSplitInstanceBindRegions	back to summary
public VkBindImageMemoryDeviceGroupInfo pSplitInstanceBindRegions(VkRect2D.Buffer value) Sets the address of the specified `VkRect2D.Buffer` to the `pSplitInstanceBindRegions` field.

set	back to summary
public VkBindImageMemoryDeviceGroupInfo set(int sType, long pNext, IntBuffer pDeviceIndices, VkRect2D.Buffer pSplitInstanceBindRegions) Initializes this struct with the specified values.

set

back to summary

public VkBindImageMemoryDeviceGroupInfo set(VkBindImageMemoryDeviceGroupInfo src)

Copies the specified struct data to this struct.

Parameters

src:VkBindImageMemoryDeviceGroupInfo: the source struct

Returns:VkBindImageMemoryDeviceGroupInfo

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

splitInstanceBindRegionCount back to summary

public int splitInstanceBindRegionCount()

the number of elements in pSplitInstanceBindRegions.

Annotations

@NativeType:uint32_t

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkBindImageMemoryDeviceGroupInfo sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkBindImageMemoryDeviceGroupInfo sType$Default() Sets the `STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO` value to the `sType` field.

validate back to summary

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

org.lwjgl.vulkan back to summary

public Class VkBindImageMemoryDeviceGroupInfo.Buffer

Class Inheritance

extends StructBuffer<VkBindImageMemoryDeviceGroupInfo, VkBindImageMemoryDeviceGroupInfo.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

Known Direct Subclasses

org.lwjgl.vulkan.VkBindImageMemoryDeviceGroupInfoKHR.Buffer

An array of VkBindImageMemoryDeviceGroupInfo structs.

Field Summary

Modifier and Type	Field and Description
private static final VkBindImageMemoryDeviceGroupInfo	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkBindImageMemoryDeviceGroupInfo.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 `VkBindImageMemoryDeviceGroupInfo#deviceIndexCount` field. deviceIndexCount()
protected VkBindImageMemoryDeviceGroupInfo	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public IntBuffer	Returns: a `IntBuffer` view of the data pointed to by the `VkBindImageMemoryDeviceGroupInfo#pDeviceIndices` field. pDeviceIndices()
public VkBindImageMemoryDeviceGroupInfo.Buffer	pDeviceIndices(IntBuffer value) Sets the address of the specified `IntBuffer` to the `VkBindImageMemoryDeviceGroupInfo#pDeviceIndices` field.
public long	Returns: the value of the `VkBindImageMemoryDeviceGroupInfo#pNext` field. pNext()
public VkBindImageMemoryDeviceGroupInfo.Buffer	pNext(long value) Sets the specified value to the `VkBindImageMemoryDeviceGroupInfo#pNext` field.
public VkRect2D.Buffer	Returns: a `VkRect2D.Buffer` view of the struct array pointed to by the `VkBindImageMemoryDeviceGroupInfo#pSplitInstanceBindRegions` field. pSplitInstanceBindRegions()
public VkBindImageMemoryDeviceGroupInfo.Buffer	pSplitInstanceBindRegions(VkRect2D.Buffer value) Sets the address of the specified `VkRect2D.Buffer` to the `VkBindImageMemoryDeviceGroupInfo#pSplitInstanceBindRegions` field.
protected VkBindImageMemoryDeviceGroupInfo.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkBindImageMemoryDeviceGroupInfo#splitInstanceBindRegionCount` field. splitInstanceBindRegionCount()
public int	Returns: the value of the `VkBindImageMemoryDeviceGroupInfo#sType` field. sType()
public VkBindImageMemoryDeviceGroupInfo.Buffer	sType(int value) Sets the specified value to the `VkBindImageMemoryDeviceGroupInfo#sType` field.
public VkBindImageMemoryDeviceGroupInfo.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO` value to the `VkBindImageMemoryDeviceGroupInfo#sType` 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 VkBindImageMemoryDeviceGroupInfo ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

deviceIndexCount	back to summary
public int deviceIndexCount() Returns:int the value of the `VkBindImageMemoryDeviceGroupInfo#deviceIndexCount` field. Annotations @NativeType:uint32_t

getElementFactory

back to summary

protected VkBindImageMemoryDeviceGroupInfo getElementFactory()

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

Annotations

@Override

pDeviceIndices	back to summary
public IntBuffer pDeviceIndices() Returns:IntBuffer a `IntBuffer` view of the data pointed to by the `VkBindImageMemoryDeviceGroupInfo#pDeviceIndices` field. Annotations @Nullable @NativeType:uint32_t const *

pDeviceIndices	back to summary
public VkBindImageMemoryDeviceGroupInfo.Buffer pDeviceIndices(IntBuffer value) Sets the address of the specified `IntBuffer` to the `VkBindImageMemoryDeviceGroupInfo#pDeviceIndices` field.

pNext	back to summary
public long pNext() Returns:long the value of the `VkBindImageMemoryDeviceGroupInfo#pNext` field. Annotations @NativeType:void const *

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

pSplitInstanceBindRegions	back to summary
public VkRect2D.Buffer pSplitInstanceBindRegions() Returns:VkRect2D.Buffer a `VkRect2D.Buffer` view of the struct array pointed to by the `VkBindImageMemoryDeviceGroupInfo#pSplitInstanceBindRegions` field. Annotations @Nullable @NativeType:VkRect2D const *

pSplitInstanceBindRegions	back to summary
public VkBindImageMemoryDeviceGroupInfo.Buffer pSplitInstanceBindRegions(VkRect2D.Buffer value) Sets the address of the specified `VkRect2D.Buffer` to the `VkBindImageMemoryDeviceGroupInfo#pSplitInstanceBindRegions` field.

self

back to summary

protected VkBindImageMemoryDeviceGroupInfo.Buffer self()

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

Annotations

@Override

splitInstanceBindRegionCount	back to summary
public int splitInstanceBindRegionCount() Returns:int the value of the `VkBindImageMemoryDeviceGroupInfo#splitInstanceBindRegionCount` field. Annotations @NativeType:uint32_t

sType	back to summary
public int sType() Returns:int the value of the `VkBindImageMemoryDeviceGroupInfo#sType` field. Annotations @NativeType:VkStructureType

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

sType$Default	back to summary
public VkBindImageMemoryDeviceGroupInfo.Buffer sType$Default() Sets the `STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO` value to the `VkBindImageMemoryDeviceGroupInfo#sType` field.

public Class VkBindImageMemoryDeviceGroupInfo

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

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail