Package org.lwjgl.vulkan

Class VkImageSubresource

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageSubresource>

org.lwjgl.vulkan.VkImageSubresource

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkImageSubresource
extends Struct<VkImageSubresource>
implements NativeResource

 struct VkImageSubresource {
     VkImageAspectFlags aspectMask;
     uint32_t mipLevel;
     uint32_t arrayLayer;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageSubresource.Buffer	An array of VkImageSubresource 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

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ARRAYLAYER	The struct member offsets.
static final int	ASPECTMASK	The struct member offsets.
static final int	MIPLEVEL	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
VkImageSubresource(ByteBuffer container)	Creates a VkImageSubresource instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	arrayLayer()
VkImageSubresource	arrayLayer(int value)	Sets the specified value to the arrayLayer field.
int	aspectMask()
VkImageSubresource	aspectMask(int value)	Sets the specified value to the aspectMask field.
static VkImageSubresource	calloc()	Returns a new VkImageSubresource instance allocated with memCalloc.
static VkImageSubresource.Buffer	calloc(int capacity)	Returns a new VkImageSubresource.Buffer instance allocated with memCalloc.
static VkImageSubresource.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkImageSubresource.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageSubresource	calloc(MemoryStack stack)	Returns a new VkImageSubresource instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageSubresource	callocStack()	Deprecated.
static VkImageSubresource.Buffer	callocStack(int capacity)	Deprecated.
static VkImageSubresource.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageSubresource	callocStack(MemoryStack stack)	Deprecated.
static VkImageSubresource	create()	Returns a new VkImageSubresource instance allocated with BufferUtils.
static VkImageSubresource.Buffer	create(int capacity)	Returns a new VkImageSubresource.Buffer instance allocated with BufferUtils.
static VkImageSubresource	create(long address)	Returns a new VkImageSubresource instance for the specified memory address.
static VkImageSubresource.Buffer	create(long address, int capacity)	Create a VkImageSubresource.Buffer instance at the specified memory.
static @Nullable VkImageSubresource	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageSubresource.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkImageSubresource	malloc()	Returns a new VkImageSubresource instance allocated with memAlloc.
static VkImageSubresource.Buffer	malloc(int capacity)	Returns a new VkImageSubresource.Buffer instance allocated with memAlloc.
static VkImageSubresource.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkImageSubresource.Buffer instance allocated on the specified MemoryStack.
static VkImageSubresource	malloc(MemoryStack stack)	Returns a new VkImageSubresource instance allocated on the specified MemoryStack.
static VkImageSubresource	mallocStack()	Deprecated.
static VkImageSubresource.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageSubresource.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageSubresource	mallocStack(MemoryStack stack)	Deprecated.
int	mipLevel()
VkImageSubresource	mipLevel(int value)	Sets the specified value to the mipLevel field.
static int	narrayLayer(long struct)	Unsafe version of arrayLayer().
static void	narrayLayer(long struct, int value)	Unsafe version of arrayLayer.
static int	naspectMask(long struct)	Unsafe version of aspectMask().
static void	naspectMask(long struct, int value)	Unsafe version of aspectMask.
static int	nmipLevel(long struct)	Unsafe version of mipLevel().
static void	nmipLevel(long struct, int value)	Unsafe version of mipLevel.
VkImageSubresource	set(int aspectMask, int mipLevel, int arrayLayer)	Initializes this struct with the specified values.
VkImageSubresource	set(VkImageSubresource src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

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.

MIPLEVEL

public static final int MIPLEVEL

The struct member offsets.

ARRAYLAYER

public static final int ARRAYLAYER

The struct member offsets.

Constructor Details

VkImageSubresource

public VkImageSubresource(ByteBuffer container)

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

aspectMask

public int aspectMask()

Returns:

the value of the aspectMask field.

mipLevel

public int mipLevel()

Returns:

the value of the mipLevel field.

arrayLayer

public int arrayLayer()

Returns:

the value of the arrayLayer field.

aspectMask

public VkImageSubresource aspectMask(int value)

Sets the specified value to the aspectMask field.

mipLevel

public VkImageSubresource mipLevel(int value)

Sets the specified value to the mipLevel field.

arrayLayer

public VkImageSubresource arrayLayer(int value)

Sets the specified value to the arrayLayer field.

set

public VkImageSubresource set(int aspectMask,
 int mipLevel,
 int arrayLayer)

Initializes this struct with the specified values.

set

public VkImageSubresource set(VkImageSubresource src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageSubresource malloc()

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

calloc

public static VkImageSubresource calloc()

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

create

public static VkImageSubresource create()

Returns a new VkImageSubresource instance allocated with BufferUtils.

create

public static VkImageSubresource create(long address)

Returns a new VkImageSubresource instance for the specified memory address.

createSafe

public static @Nullable VkImageSubresource createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageSubresource.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageSubresource.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageSubresource.Buffer create(int capacity)

Returns a new VkImageSubresource.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageSubresource.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageSubresource mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageSubresource callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageSubresource mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageSubresource callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkImageSubresource malloc(MemoryStack stack)

Returns a new VkImageSubresource instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageSubresource calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkImageSubresource.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().

nmipLevel

public static int nmipLevel(long struct)

Unsafe version of mipLevel().

narrayLayer

public static int narrayLayer(long struct)

Unsafe version of arrayLayer().

naspectMask

public static void naspectMask(long struct,
 int value)

Unsafe version of aspectMask.

nmipLevel

public static void nmipLevel(long struct,
 int value)

Unsafe version of mipLevel.

narrayLayer

public static void narrayLayer(long struct,
 int value)

Unsafe version of arrayLayer.