Structure specifying sparse image format inputs.

Valid Usage

samples must be a bit value that is set in VkImageFormatProperties::sampleCounts returned by vkGetPhysicalDeviceImageFormatProperties with format, type, tiling, and usage equal to those in this command and flags equal to the value that is set in VkImageCreateInfo::flags when the image is created

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2
pNext must be NULL
format must be a valid VkFormat value
type must be a valid VkImageType value
samples must be a valid VkSampleCountFlagBits value
usage must be a valid combination of VkImageUsageFlagBits values
usage must not be 0
tiling must be a valid VkImageTiling value

Layout


struct VkPhysicalDeviceSparseImageFormatInfo2 {
    VkStructureType sType;
    void const * pNext;
    VkFormat format;
    VkImageType type;
    VkSampleCountFlagBits samples;
    VkImageUsageFlags usage;
    VkImageTiling tiling;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FORMAT The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SAMPLES The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.
public static final int	TILING The struct member offsets.
public static final int	TYPE The struct member offsets.
public static final int	USAGE The struct member offsets.

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public static VkPhysicalDeviceSparseImageFormatInfo2	calloc() Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated with `memCalloc`.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated with `memCalloc`.
public static VkPhysicalDeviceSparseImageFormatInfo2	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPhysicalDeviceSparseImageFormatInfo2	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceSparseImageFormatInfo2	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkPhysicalDeviceSparseImageFormatInfo2	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 VkPhysicalDeviceSparseImageFormatInfo2	create() Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated with `BufferUtils`.
public static VkPhysicalDeviceSparseImageFormatInfo2	create(long address) Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance for the specified memory address.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	create(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated with `BufferUtils`.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance at the specified memory.
public static VkPhysicalDeviceSparseImageFormatInfo2	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	format() the image format.
public VkPhysicalDeviceSparseImageFormatInfo2	format(int value) Sets the specified value to the `format` field.
public static VkPhysicalDeviceSparseImageFormatInfo2	malloc() Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated with `memAlloc`.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated with `memAlloc`.
public static VkPhysicalDeviceSparseImageFormatInfo2	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated on the specified `MemoryStack`.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated on the specified `MemoryStack`.
public static VkPhysicalDeviceSparseImageFormatInfo2	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceSparseImageFormatInfo2	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nformat(long struct) Unsafe version of `format`.
public static void	nformat(long struct, int value) Unsafe version of `format`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nsamples(long struct) Unsafe version of `samples`.
public static void	nsamples(long struct, int value) Unsafe version of `samples`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public static int	ntiling(long struct) Unsafe version of `tiling`.
public static void	ntiling(long struct, int value) Unsafe version of `tiling`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public static int	nusage(long struct) Unsafe version of `usage`.
public static void	nusage(long struct, int value) Unsafe version of `usage`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkPhysicalDeviceSparseImageFormatInfo2	pNext(long value) Sets the specified value to the `pNext` field.
public int	samples() a `VkSampleCountFlagBits` value specifying the number of samples per texel.
public VkPhysicalDeviceSparseImageFormatInfo2	samples(int value) Sets the specified value to the `samples` field.
public VkPhysicalDeviceSparseImageFormatInfo2	set(int sType, long pNext, int format, int type, int samples, int usage, int tiling) Initializes this struct with the specified values.
public VkPhysicalDeviceSparseImageFormatInfo2	Returns: this struct set(VkPhysicalDeviceSparseImageFormatInfo2 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	sType() a `VkStructureType` value identifying this structure.
public VkPhysicalDeviceSparseImageFormatInfo2	sType(int value) Sets the specified value to the `sType` field.
public VkPhysicalDeviceSparseImageFormatInfo2	sType$Default() Sets the `STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2` value to the `sType` field.
public int	tiling() the tiling arrangement of the texel blocks in memory.
public VkPhysicalDeviceSparseImageFormatInfo2	tiling(int value) Sets the specified value to the `tiling` field.
public int	type() the dimensionality of image.
public VkPhysicalDeviceSparseImageFormatInfo2	type(int value) Sets the specified value to the `type` field.
public int	usage() a bitmask describing the intended usage of the image.
public VkPhysicalDeviceSparseImageFormatInfo2	usage(int value) Sets the specified value to the `usage` field.

Field Detail

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

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

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

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

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

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

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

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

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

Constructor Detail

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

VkPhysicalDeviceSparseImageFormatInfo2 back to summary

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

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

calloc back to summary

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

public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer calloc(int capacity)

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

public static VkPhysicalDeviceSparseImageFormatInfo2 calloc(MemoryStack stack)

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

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

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

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

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

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

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

create back to summary

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

public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer create(int capacity)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static VkPhysicalDeviceSparseImageFormatInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

format	back to summary
public int format() the image format. Annotations @NativeType:VkFormat

format

back to summary

public int format()

the image format.

Annotations

@NativeType:VkFormat

format	back to summary
public VkPhysicalDeviceSparseImageFormatInfo2 format(int value) Sets the specified value to the `format` field.

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

malloc back to summary

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

public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer malloc(int capacity)

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

public static VkPhysicalDeviceSparseImageFormatInfo2 malloc(MemoryStack stack)

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

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

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

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

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

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

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

Deprecated

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

Annotations

@Deprecated

nformat	back to summary
public static int nformat(long struct) Unsafe version of `format`.

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

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

nsamples	back to summary
public static int nsamples(long struct) Unsafe version of `samples`.

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

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

ntiling	back to summary
public static int ntiling(long struct) Unsafe version of `tiling`.

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

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

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

nusage	back to summary
public static int nusage(long struct) Unsafe version of `usage`.

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

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 VkPhysicalDeviceSparseImageFormatInfo2 pNext(long value) Sets the specified value to the `pNext` field.

samples back to summary

public int samples()

a VkSampleCountFlagBits value specifying the number of samples per texel.

Annotations

@NativeType:VkSampleCountFlagBits

samples	back to summary
public VkPhysicalDeviceSparseImageFormatInfo2 samples(int value) Sets the specified value to the `samples` field.

set	back to summary
public VkPhysicalDeviceSparseImageFormatInfo2 set(int sType, long pNext, int format, int type, int samples, int usage, int tiling) Initializes this struct with the specified values.

set

back to summary

public VkPhysicalDeviceSparseImageFormatInfo2 set(VkPhysicalDeviceSparseImageFormatInfo2 src)

Copies the specified struct data to this struct.

Parameters

src:VkPhysicalDeviceSparseImageFormatInfo2: the source struct

Returns:VkPhysicalDeviceSparseImageFormatInfo2

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

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

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

sType$Default	back to summary
public VkPhysicalDeviceSparseImageFormatInfo2 sType$Default() Sets the `STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2` value to the `sType` field.

tiling

back to summary

public int tiling()

the tiling arrangement of the texel blocks in memory.

Annotations

@NativeType:VkImageTiling

tiling	back to summary
public VkPhysicalDeviceSparseImageFormatInfo2 tiling(int value) Sets the specified value to the `tiling` field.

type

back to summary

public int type()

the dimensionality of image.

Annotations

@NativeType:VkImageType

type	back to summary
public VkPhysicalDeviceSparseImageFormatInfo2 type(int value) Sets the specified value to the `type` field.

usage

back to summary

public int usage()

a bitmask describing the intended usage of the image.

Annotations

@NativeType:VkImageUsageFlags

usage	back to summary
public VkPhysicalDeviceSparseImageFormatInfo2 usage(int value) Sets the specified value to the `usage` field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceSparseImageFormatInfo2.Buffer

Class Inheritance

extends StructBuffer<VkPhysicalDeviceSparseImageFormatInfo2, VkPhysicalDeviceSparseImageFormatInfo2.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

Known Direct Subclasses

org.lwjgl.vulkan.VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer

An array of VkPhysicalDeviceSparseImageFormatInfo2 structs.

Field Summary

Modifier and Type	Field and Description
private static final VkPhysicalDeviceSparseImageFormatInfo2	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkPhysicalDeviceSparseImageFormatInfo2.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 `VkPhysicalDeviceSparseImageFormatInfo2#format` field. format()
public VkPhysicalDeviceSparseImageFormatInfo2.Buffer	format(int value) Sets the specified value to the `VkPhysicalDeviceSparseImageFormatInfo2#format` field.
protected VkPhysicalDeviceSparseImageFormatInfo2	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkPhysicalDeviceSparseImageFormatInfo2#pNext` field. pNext()
public VkPhysicalDeviceSparseImageFormatInfo2.Buffer	pNext(long value) Sets the specified value to the `VkPhysicalDeviceSparseImageFormatInfo2#pNext` field.
public int	Returns: the value of the `VkPhysicalDeviceSparseImageFormatInfo2#samples` field. samples()
public VkPhysicalDeviceSparseImageFormatInfo2.Buffer	samples(int value) Sets the specified value to the `VkPhysicalDeviceSparseImageFormatInfo2#samples` field.
protected VkPhysicalDeviceSparseImageFormatInfo2.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkPhysicalDeviceSparseImageFormatInfo2#sType` field. sType()
public VkPhysicalDeviceSparseImageFormatInfo2.Buffer	sType(int value) Sets the specified value to the `VkPhysicalDeviceSparseImageFormatInfo2#sType` field.
public VkPhysicalDeviceSparseImageFormatInfo2.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2` value to the `VkPhysicalDeviceSparseImageFormatInfo2#sType` field.
public int	Returns: the value of the `VkPhysicalDeviceSparseImageFormatInfo2#tiling` field. tiling()
public VkPhysicalDeviceSparseImageFormatInfo2.Buffer	tiling(int value) Sets the specified value to the `VkPhysicalDeviceSparseImageFormatInfo2#tiling` field.
public int	Returns: the value of the `VkPhysicalDeviceSparseImageFormatInfo2#type` field. type()
public VkPhysicalDeviceSparseImageFormatInfo2.Buffer	type(int value) Sets the specified value to the `VkPhysicalDeviceSparseImageFormatInfo2#type` field.
public int	Returns: the value of the `VkPhysicalDeviceSparseImageFormatInfo2#usage` field. usage()
public VkPhysicalDeviceSparseImageFormatInfo2.Buffer	usage(int value) Sets the specified value to the `VkPhysicalDeviceSparseImageFormatInfo2#usage` 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 VkPhysicalDeviceSparseImageFormatInfo2 ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

format	back to summary
public int format() Returns:int the value of the `VkPhysicalDeviceSparseImageFormatInfo2#format` field. Annotations @NativeType:VkFormat

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

getElementFactory

back to summary

protected VkPhysicalDeviceSparseImageFormatInfo2 getElementFactory()

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

Annotations

@Override

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

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

samples	back to summary
public int samples() Returns:int the value of the `VkPhysicalDeviceSparseImageFormatInfo2#samples` field. Annotations @NativeType:VkSampleCountFlagBits

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

self

back to summary

protected VkPhysicalDeviceSparseImageFormatInfo2.Buffer self()

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

Annotations

@Override

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

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

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

tiling	back to summary
public int tiling() Returns:int the value of the `VkPhysicalDeviceSparseImageFormatInfo2#tiling` field. Annotations @NativeType:VkImageTiling

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

type	back to summary
public int type() Returns:int the value of the `VkPhysicalDeviceSparseImageFormatInfo2#type` field. Annotations @NativeType:VkImageType

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

usage	back to summary
public int usage() Returns:int the value of the `VkPhysicalDeviceSparseImageFormatInfo2#usage` field. Annotations @NativeType:VkImageUsageFlags

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

public Class VkPhysicalDeviceSparseImageFormatInfo2

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

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail