Class VkPhysicalDeviceSparseImageFormatInfo2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceSparseImageFormatInfo2>

org.lwjgl.vulkan.VkPhysicalDeviceSparseImageFormatInfo2

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkPhysicalDeviceSparseImageFormatInfo2KHR

public class VkPhysicalDeviceSparseImageFormatInfo2
extends Struct<VkPhysicalDeviceSparseImageFormatInfo2>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

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

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPhysicalDeviceSparseImageFormatInfo2(ByteBuffer container)	Creates a VkPhysicalDeviceSparseImageFormatInfo2 instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceSparseImageFormatInfo2	calloc()	Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated with memCalloc.
static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated with memCalloc.
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.
static VkPhysicalDeviceSparseImageFormatInfo2	calloc(MemoryStack stack)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceSparseImageFormatInfo2	create()	Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated with BufferUtils.
static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceSparseImageFormatInfo2	create(long address)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance for the specified memory address.
static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceSparseImageFormatInfo2	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceSparseImageFormatInfo2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	format()
VkPhysicalDeviceSparseImageFormatInfo2	format(int value)	Sets the specified value to the format field.
static VkPhysicalDeviceSparseImageFormatInfo2	malloc()	Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated with memAlloc.
static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceSparseImageFormatInfo2.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceSparseImageFormatInfo2	malloc(MemoryStack stack)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated on the specified MemoryStack.
static int	nformat(long struct)	Unsafe version of format().
static void	nformat(long struct, int value)	Unsafe version of format.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsamples(long struct)	Unsafe version of samples().
static void	nsamples(long struct, int value)	Unsafe version of samples.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntiling(long struct)	Unsafe version of tiling().
static void	ntiling(long struct, int value)	Unsafe version of tiling.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static int	nusage(long struct)	Unsafe version of usage().
static void	nusage(long struct, int value)	Unsafe version of usage.
long	pNext()
VkPhysicalDeviceSparseImageFormatInfo2	pNext(long value)	Sets the specified value to the pNext field.
int	samples()
VkPhysicalDeviceSparseImageFormatInfo2	samples(int value)	Sets the specified value to the samples field.
VkPhysicalDeviceSparseImageFormatInfo2	set(int sType, long pNext, int format, int type, int samples, int usage, int tiling)	Initializes this struct with the specified values.
VkPhysicalDeviceSparseImageFormatInfo2	set(VkPhysicalDeviceSparseImageFormatInfo2 src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkPhysicalDeviceSparseImageFormatInfo2	sType(int value)	Sets the specified value to the sType field.
VkPhysicalDeviceSparseImageFormatInfo2	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2 value to the sType field.
int	tiling()
VkPhysicalDeviceSparseImageFormatInfo2	tiling(int value)	Sets the specified value to the tiling field.
int	type()
VkPhysicalDeviceSparseImageFormatInfo2	type(int value)	Sets the specified value to the type field.
int	usage()
VkPhysicalDeviceSparseImageFormatInfo2	usage(int value)	Sets the specified value to the usage field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FORMAT

public static final int FORMAT

The struct member offsets.

TYPE

public static final int TYPE

The struct member offsets.

SAMPLES

public static final int SAMPLES

The struct member offsets.

USAGE

public static final int USAGE

The struct member offsets.

TILING

public static final int TILING

The struct member offsets.

Constructor Details

VkPhysicalDeviceSparseImageFormatInfo2

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPhysicalDeviceSparseImageFormatInfo2>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

format

@NativeType("VkFormat")
public int format()

Returns:

the value of the format field.

type

@NativeType("VkImageType")
public int type()

Returns:

the value of the type field.

samples

@NativeType("VkSampleCountFlagBits")
public int samples()

Returns:

the value of the samples field.

usage

@NativeType("VkImageUsageFlags")
public int usage()

Returns:

the value of the usage field.

tiling

@NativeType("VkImageTiling")
public int tiling()

Returns:

the value of the tiling field.

sType

public VkPhysicalDeviceSparseImageFormatInfo2 sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkPhysicalDeviceSparseImageFormatInfo2 sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2 value to the sType field.

pNext

public VkPhysicalDeviceSparseImageFormatInfo2 pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

format

public VkPhysicalDeviceSparseImageFormatInfo2 format(@NativeType("VkFormat")
 int value)

Sets the specified value to the format field.

type

public VkPhysicalDeviceSparseImageFormatInfo2 type(@NativeType("VkImageType")
 int value)

Sets the specified value to the type field.

samples

public VkPhysicalDeviceSparseImageFormatInfo2 samples(@NativeType("VkSampleCountFlagBits")
 int value)

Sets the specified value to the samples field.

usage

public VkPhysicalDeviceSparseImageFormatInfo2 usage(@NativeType("VkImageUsageFlags")
 int value)

Sets the specified value to the usage field.

tiling

public VkPhysicalDeviceSparseImageFormatInfo2 tiling(@NativeType("VkImageTiling")
 int value)

Sets the specified value to the tiling field.

set

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

public VkPhysicalDeviceSparseImageFormatInfo2 set(VkPhysicalDeviceSparseImageFormatInfo2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceSparseImageFormatInfo2 malloc()

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

calloc

public static VkPhysicalDeviceSparseImageFormatInfo2 calloc()

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

create

public static VkPhysicalDeviceSparseImageFormatInfo2 create()

Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated with BufferUtils.

create

public static VkPhysicalDeviceSparseImageFormatInfo2 create(long address)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceSparseImageFormatInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer create(int capacity)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceSparseImageFormatInfo2 malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nformat

public static int nformat(long struct)

Unsafe version of format().

ntype

public static int ntype(long struct)

Unsafe version of type().

nsamples

public static int nsamples(long struct)

Unsafe version of samples().

nusage

public static int nusage(long struct)

Unsafe version of usage().

ntiling

public static int ntiling(long struct)

Unsafe version of tiling().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nformat

public static void nformat(long struct,
 int value)

Unsafe version of format.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nsamples

public static void nsamples(long struct,
 int value)

Unsafe version of samples.

nusage

public static void nusage(long struct,
 int value)

Unsafe version of usage.

ntiling

public static void ntiling(long struct,
 int value)

Unsafe version of tiling.