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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ASPECTMASK The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	IMAGEGRANULARITY The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

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

Method Summary

Modifier and Type	Method and Description
public int	aspectMask() a bitmask `VkImageAspectFlagBits` specifying which aspects of the image the properties apply to.
public static VkSparseImageFormatProperties	calloc() Returns a new `VkSparseImageFormatProperties` instance allocated with `memCalloc`.
public static VkSparseImageFormatProperties.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated with `memCalloc`.
public static VkSparseImageFormatProperties	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSparseImageFormatProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSparseImageFormatProperties.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSparseImageFormatProperties	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkSparseImageFormatProperties	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 VkSparseImageFormatProperties	create() Returns a new `VkSparseImageFormatProperties` instance allocated with `BufferUtils`.
public static VkSparseImageFormatProperties	create(long address) Returns a new `VkSparseImageFormatProperties` instance for the specified memory address.
public static VkSparseImageFormatProperties.Buffer	create(int the buffer capacity capacity) Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated with `BufferUtils`.
public static VkSparseImageFormatProperties.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSparseImageFormatProperties.Buffer` instance at the specified memory.
public static VkSparseImageFormatProperties	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSparseImageFormatProperties.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkSparseImageFormatFlagBits` specifying additional information about the sparse resource.
public VkExtent3D	imageGranularity() the width, height, and depth of the sparse image block in texels or compressed texel blocks.
public static VkSparseImageFormatProperties	malloc() Returns a new `VkSparseImageFormatProperties` instance allocated with `memAlloc`.
public static VkSparseImageFormatProperties.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated with `memAlloc`.
public static VkSparseImageFormatProperties	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSparseImageFormatProperties` instance allocated on the specified `MemoryStack`.
public static VkSparseImageFormatProperties.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack`.
public static VkSparseImageFormatProperties	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	naspectMask(long struct) Unsafe version of `aspectMask`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static VkExtent3D	nimageGranularity(long struct) Unsafe version of `imageGranularity`.
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.

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

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

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

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

Constructor Detail

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

VkSparseImageFormatProperties back to summary

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

Creates a VkSparseImageFormatProperties 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

aspectMask back to summary

aspectMask	back to summary
public int aspectMask() a bitmask `VkImageAspectFlagBits` specifying which aspects of the image the properties apply to. Annotations @NativeType:VkImageAspectFlags

public int aspectMask()

a bitmask VkImageAspectFlagBits specifying which aspects of the image the properties apply to.

Annotations

@NativeType:VkImageAspectFlags

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

calloc back to summary

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

public static VkSparseImageFormatProperties.Buffer calloc(int capacity)

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

public static VkSparseImageFormatProperties calloc(MemoryStack stack)

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

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

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

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

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

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

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

create back to summary

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

public static VkSparseImageFormatProperties.Buffer create(int capacity)

Returns a new VkSparseImageFormatProperties.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static VkSparseImageFormatProperties createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

public static VkSparseImageFormatProperties.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 `VkSparseImageFormatFlagBits` specifying additional information about the sparse resource. Annotations @NativeType:VkSparseImageFormatFlags

public int flags()

a bitmask of VkSparseImageFormatFlagBits specifying additional information about the sparse resource.

Annotations

@NativeType:VkSparseImageFormatFlags

imageGranularity	back to summary
public VkExtent3D imageGranularity() the width, height, and depth of the sparse image block in texels or compressed texel blocks.

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

malloc back to summary

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

public static VkSparseImageFormatProperties.Buffer malloc(int capacity)

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

public static VkSparseImageFormatProperties malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

naspectMask	back to summary
public static int naspectMask(long struct) Unsafe version of `aspectMask`.

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

nimageGranularity	back to summary
public static VkExtent3D nimageGranularity(long struct) Unsafe version of `imageGranularity`.

sizeof back to summary

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

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

Class Inheritance

extends StructBuffer<VkSparseImageFormatProperties, VkSparseImageFormatProperties.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkSparseImageFormatProperties structs.

Field Summary

Modifier and Type	Field and Description
private static final VkSparseImageFormatProperties	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkSparseImageFormatProperties.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 `VkSparseImageFormatProperties#aspectMask` field. aspectMask()
public int	Returns: the value of the `VkSparseImageFormatProperties#flags` field. flags()
protected VkSparseImageFormatProperties	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public VkExtent3D	Returns: a `VkExtent3D` view of the `VkSparseImageFormatProperties#imageGranularity` field. imageGranularity()
protected VkSparseImageFormatProperties.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

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

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkSparseImageFormatProperties.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 `VkSparseImageFormatProperties#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

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

aspectMask	back to summary
public int aspectMask() Returns:int the value of the `VkSparseImageFormatProperties#aspectMask` field. Annotations @NativeType:VkImageAspectFlags