Package org.lwjgl.vulkan

Class VkPhysicalDeviceSparseImageFormatInfo2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceSparseImageFormatInfo2>

org.lwjgl.vulkan.VkPhysicalDeviceSparseImageFormatInfo2

org.lwjgl.vulkan.VkPhysicalDeviceSparseImageFormatInfo2KHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkPhysicalDeviceSparseImageFormatInfo2KHR
extends VkPhysicalDeviceSparseImageFormatInfo2

See VkPhysicalDeviceSparseImageFormatInfo2.

Layout

 struct VkPhysicalDeviceSparseImageFormatInfo2KHR {
     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	VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	An array of VkPhysicalDeviceSparseImageFormatInfo2KHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields inherited from class org.lwjgl.vulkan.VkPhysicalDeviceSparseImageFormatInfo2

ALIGNOF, FORMAT, PNEXT, SAMPLES, SIZEOF, STYPE, TILING, TYPE, USAGE

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceSparseImageFormatInfo2KHR	calloc()	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance allocated with memCalloc.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	calloc(MemoryStack stack)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	callocStack()	Deprecated.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	callocStack(MemoryStack stack)	Deprecated.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	create()	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance allocated with BufferUtils.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	create(long address)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance for the specified memory address.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer instance at the specified memory.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkPhysicalDeviceSparseImageFormatInfo2KHR	format(int value)	Sets the specified value to the format field.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	malloc()	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance allocated with memAlloc.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	malloc(MemoryStack stack)	Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance allocated on the specified MemoryStack.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	mallocStack()	Deprecated.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPhysicalDeviceSparseImageFormatInfo2KHR	mallocStack(MemoryStack stack)	Deprecated.
VkPhysicalDeviceSparseImageFormatInfo2KHR	pNext(long value)	Sets the specified value to the pNext field.
VkPhysicalDeviceSparseImageFormatInfo2KHR	samples(int value)	Sets the specified value to the samples field.
VkPhysicalDeviceSparseImageFormatInfo2KHR	set(int sType, long pNext, int format, int type, int samples, int usage, int tiling)	Initializes this struct with the specified values.
VkPhysicalDeviceSparseImageFormatInfo2KHR	set(VkPhysicalDeviceSparseImageFormatInfo2KHR src)	Copies the specified struct data to this struct.
VkPhysicalDeviceSparseImageFormatInfo2KHR	sType(int value)	Sets the specified value to the sType field.
VkPhysicalDeviceSparseImageFormatInfo2KHR	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2 value to the sType field.
VkPhysicalDeviceSparseImageFormatInfo2KHR	tiling(int value)	Sets the specified value to the tiling field.
VkPhysicalDeviceSparseImageFormatInfo2KHR	type(int value)	Sets the specified value to the type field.
VkPhysicalDeviceSparseImageFormatInfo2KHR	usage(int value)	Sets the specified value to the usage field.

Methods inherited from class org.lwjgl.vulkan.VkPhysicalDeviceSparseImageFormatInfo2

format, nformat, nformat, npNext, npNext, nsamples, nsamples, nsType, nsType, ntiling, ntiling, ntype, ntype, nusage, nusage, pNext, samples, set, sizeof, sType, tiling, type, usage

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Constructor Details

VkPhysicalDeviceSparseImageFormatInfo2KHR

public VkPhysicalDeviceSparseImageFormatInfo2KHR(ByteBuffer container)

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

sType

public VkPhysicalDeviceSparseImageFormatInfo2KHR sType(int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkPhysicalDeviceSparseImageFormatInfo2

sType$Default

public VkPhysicalDeviceSparseImageFormatInfo2KHR sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2 value to the sType field.

Overrides:

sType$Default in class VkPhysicalDeviceSparseImageFormatInfo2

pNext

public VkPhysicalDeviceSparseImageFormatInfo2KHR pNext(long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkPhysicalDeviceSparseImageFormatInfo2

format

public VkPhysicalDeviceSparseImageFormatInfo2KHR format(int value)

Sets the specified value to the format field.

Overrides:

format in class VkPhysicalDeviceSparseImageFormatInfo2

type

public VkPhysicalDeviceSparseImageFormatInfo2KHR type(int value)

Sets the specified value to the type field.

Overrides:

type in class VkPhysicalDeviceSparseImageFormatInfo2

samples

public VkPhysicalDeviceSparseImageFormatInfo2KHR samples(int value)

Sets the specified value to the samples field.

Overrides:

samples in class VkPhysicalDeviceSparseImageFormatInfo2

usage

public VkPhysicalDeviceSparseImageFormatInfo2KHR usage(int value)

Sets the specified value to the usage field.

Overrides:

usage in class VkPhysicalDeviceSparseImageFormatInfo2

tiling

public VkPhysicalDeviceSparseImageFormatInfo2KHR tiling(int value)

Sets the specified value to the tiling field.

Overrides:

tiling in class VkPhysicalDeviceSparseImageFormatInfo2

set

public VkPhysicalDeviceSparseImageFormatInfo2KHR set(int sType,
 long pNext,
 int format,
 int type,
 int samples,
 int usage,
 int tiling)

Initializes this struct with the specified values.

Overrides:

set in class VkPhysicalDeviceSparseImageFormatInfo2

set

public VkPhysicalDeviceSparseImageFormatInfo2KHR set(VkPhysicalDeviceSparseImageFormatInfo2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceSparseImageFormatInfo2KHR malloc()

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

calloc

public static VkPhysicalDeviceSparseImageFormatInfo2KHR calloc()

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

create

public static VkPhysicalDeviceSparseImageFormatInfo2KHR create()

Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance allocated with BufferUtils.

create

public static VkPhysicalDeviceSparseImageFormatInfo2KHR create(long address)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance for the specified memory address.

createSafe

@Nullable
public static VkPhysicalDeviceSparseImageFormatInfo2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer create(int capacity)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2KHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2KHR callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2KHR mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2KHR callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkPhysicalDeviceSparseImageFormatInfo2KHR malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceSparseImageFormatInfo2KHR calloc(MemoryStack stack)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceSparseImageFormatInfo2KHR.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkPhysicalDeviceSparseImageFormatInfo2KHR.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