Package org.lwjgl.vulkan

Class VkSparseImageFormatProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSparseImageFormatProperties>

org.lwjgl.vulkan.VkSparseImageFormatProperties

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkSparseImageFormatProperties
extends org.lwjgl.system.Struct<VkSparseImageFormatProperties>
implements org.lwjgl.system.NativeResource

Structure specifying sparse image format properties.

See Also

VkExtent3D, VkSparseImageFormatProperties2, VkSparseImageMemoryRequirements, GetPhysicalDeviceSparseImageFormatProperties

Layout

 struct VkSparseImageFormatProperties {
     VkImageAspectFlags aspectMask();
     VkExtent3D imageGranularity();
     VkSparseImageFormatFlags flags();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

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

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

ASPECTMASK

public static final int ASPECTMASK

The struct member offsets.

IMAGEGRANULARITY

public static final int IMAGEGRANULARITY

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

VkSparseImageFormatProperties

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkSparseImageFormatProperties>

aspectMask

public int aspectMask()

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

imageGranularity

public VkExtent3D imageGranularity()

the width, height, and depth of the sparse image block in texels or compressed texel blocks.

flags

public int flags()

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

malloc

public static VkSparseImageFormatProperties malloc()

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

calloc

public static VkSparseImageFormatProperties calloc()

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

create

public static VkSparseImageFormatProperties create()

Returns a new VkSparseImageFormatProperties instance allocated with BufferUtils.

create

public static VkSparseImageFormatProperties create(long address)

Returns a new VkSparseImageFormatProperties instance for the specified memory address.

createSafe

public static @Nullable VkSparseImageFormatProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSparseImageFormatProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSparseImageFormatProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSparseImageFormatProperties.Buffer create(int capacity)

Returns a new VkSparseImageFormatProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSparseImageFormatProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSparseImageFormatProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSparseImageFormatProperties callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSparseImageFormatProperties mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSparseImageFormatProperties callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkSparseImageFormatProperties.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSparseImageFormatProperties.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkSparseImageFormatProperties malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkSparseImageFormatProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSparseImageFormatProperties calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSparseImageFormatProperties.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

naspectMask

public static int naspectMask(long struct)

Unsafe version of aspectMask().

nimageGranularity

public static VkExtent3D nimageGranularity(long struct)

Unsafe version of imageGranularity().

nflags

public static int nflags(long struct)

Unsafe version of flags().