Package org.lwjgl.vulkan

Class VkImageSubresourceLayers

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageSubresourceLayers>

org.lwjgl.vulkan.VkImageSubresourceLayers

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkImageSubresourceLayers
extends Struct<VkImageSubresourceLayers>
implements NativeResource

Structure specifying an image subresource layers.

Valid Usage

• If aspectMask contains IMAGE_ASPECT_COLOR_BIT, it must not contain either of IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• aspectMask must not contain IMAGE_ASPECT_METADATA_BIT
• aspectMask must not include VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT for any index i
• If the maintenance5 feature is not enabled, layerCount must not be REMAINING_ARRAY_LAYERS
• If layerCount is not REMAINING_ARRAY_LAYERS, it must be greater than 0

Valid Usage (Implicit)

• aspectMask must be a valid combination of VkImageAspectFlagBits values
• aspectMask must not be 0

See Also

VkBufferImageCopy, VkBufferImageCopy2, VkCopyMemoryToImageIndirectCommandNV, VkImageBlit, VkImageBlit2, VkImageCopy, VkImageCopy2, VkImageResolve, VkImageResolve2, VkImageToMemoryCopyEXT, VkMemoryToImageCopyEXT, CmdCopyMemoryToImageIndirectNV

Layout

 struct VkImageSubresourceLayers {
     VkImageAspectFlags aspectMask();
     uint32_t mipLevel();
     uint32_t baseArrayLayer();
     uint32_t layerCount();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageSubresourceLayers.Buffer	An array of VkImageSubresourceLayers 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	ASPECTMASK	The struct member offsets.
static final int	BASEARRAYLAYER	The struct member offsets.
static final int	LAYERCOUNT	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
VkImageSubresourceLayers(ByteBuffer container)	Creates a VkImageSubresourceLayers instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	aspectMask()	a combination of VkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied.
VkImageSubresourceLayers	aspectMask(int value)	Sets the specified value to the aspectMask() field.
int	baseArrayLayer()	baseArrayLayer and layerCount are the starting layer and number of layers to copy.
VkImageSubresourceLayers	baseArrayLayer(int value)	Sets the specified value to the baseArrayLayer() field.
static VkImageSubresourceLayers	calloc()	Returns a new VkImageSubresourceLayers instance allocated with memCalloc.
static VkImageSubresourceLayers.Buffer	calloc(int capacity)	Returns a new VkImageSubresourceLayers.Buffer instance allocated with memCalloc.
static VkImageSubresourceLayers.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkImageSubresourceLayers.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageSubresourceLayers	calloc(MemoryStack stack)	Returns a new VkImageSubresourceLayers instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageSubresourceLayers	callocStack()	Deprecated.
static VkImageSubresourceLayers.Buffer	callocStack(int capacity)	Deprecated.
static VkImageSubresourceLayers.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageSubresourceLayers	callocStack(MemoryStack stack)	Deprecated.
static VkImageSubresourceLayers	create()	Returns a new VkImageSubresourceLayers instance allocated with BufferUtils.
static VkImageSubresourceLayers.Buffer	create(int capacity)	Returns a new VkImageSubresourceLayers.Buffer instance allocated with BufferUtils.
static VkImageSubresourceLayers	create(long address)	Returns a new VkImageSubresourceLayers instance for the specified memory address.
static VkImageSubresourceLayers.Buffer	create(long address, int capacity)	Create a VkImageSubresourceLayers.Buffer instance at the specified memory.
static VkImageSubresourceLayers	createSafe(long address)	Like create, but returns null if address is NULL.
static VkImageSubresourceLayers.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	layerCount()	see baseArrayLayer
VkImageSubresourceLayers	layerCount(int value)	Sets the specified value to the layerCount() field.
static VkImageSubresourceLayers	malloc()	Returns a new VkImageSubresourceLayers instance allocated with memAlloc.
static VkImageSubresourceLayers.Buffer	malloc(int capacity)	Returns a new VkImageSubresourceLayers.Buffer instance allocated with memAlloc.
static VkImageSubresourceLayers.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkImageSubresourceLayers.Buffer instance allocated on the specified MemoryStack.
static VkImageSubresourceLayers	malloc(MemoryStack stack)	Returns a new VkImageSubresourceLayers instance allocated on the specified MemoryStack.
static VkImageSubresourceLayers	mallocStack()	Deprecated.
static VkImageSubresourceLayers.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageSubresourceLayers.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageSubresourceLayers	mallocStack(MemoryStack stack)	Deprecated.
int	mipLevel()	the mipmap level to copy
VkImageSubresourceLayers	mipLevel(int value)	Sets the specified value to the mipLevel() field.
static int	naspectMask(long struct)	Unsafe version of aspectMask().
static void	naspectMask(long struct, int value)	Unsafe version of aspectMask.
static int	nbaseArrayLayer(long struct)	Unsafe version of baseArrayLayer().
static void	nbaseArrayLayer(long struct, int value)	Unsafe version of baseArrayLayer.
static int	nlayerCount(long struct)	Unsafe version of layerCount().
static void	nlayerCount(long struct, int value)	Unsafe version of layerCount.
static int	nmipLevel(long struct)	Unsafe version of mipLevel().
static void	nmipLevel(long struct, int value)	Unsafe version of mipLevel.
VkImageSubresourceLayers	set(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount)	Initializes this struct with the specified values.
VkImageSubresourceLayers	set(VkImageSubresourceLayers 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

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.

BASEARRAYLAYER

public static final int BASEARRAYLAYER

The struct member offsets.

LAYERCOUNT

public static final int LAYERCOUNT

The struct member offsets.

Constructor Details

VkImageSubresourceLayers

public VkImageSubresourceLayers(ByteBuffer container)

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

aspectMask

public int aspectMask()

a combination of VkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied.

mipLevel

public int mipLevel()

the mipmap level to copy

baseArrayLayer

public int baseArrayLayer()

baseArrayLayer and layerCount are the starting layer and number of layers to copy.

layerCount

public int layerCount()

see baseArrayLayer

aspectMask

public VkImageSubresourceLayers aspectMask(int value)

Sets the specified value to the aspectMask() field.

mipLevel

public VkImageSubresourceLayers mipLevel(int value)

Sets the specified value to the mipLevel() field.

baseArrayLayer

public VkImageSubresourceLayers baseArrayLayer(int value)

Sets the specified value to the baseArrayLayer() field.

layerCount

public VkImageSubresourceLayers layerCount(int value)

Sets the specified value to the layerCount() field.

set

public VkImageSubresourceLayers set(int aspectMask,
 int mipLevel,
 int baseArrayLayer,
 int layerCount)

Initializes this struct with the specified values.

set

public VkImageSubresourceLayers set(VkImageSubresourceLayers src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageSubresourceLayers malloc()

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

calloc

public static VkImageSubresourceLayers calloc()

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

create

public static VkImageSubresourceLayers create()

Returns a new VkImageSubresourceLayers instance allocated with BufferUtils.

create

public static VkImageSubresourceLayers create(long address)

Returns a new VkImageSubresourceLayers instance for the specified memory address.

createSafe

@Nullable
public static VkImageSubresourceLayers createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageSubresourceLayers.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageSubresourceLayers.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageSubresourceLayers.Buffer create(int capacity)

Returns a new VkImageSubresourceLayers.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageSubresourceLayers.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageSubresourceLayers mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageSubresourceLayers callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageSubresourceLayers mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageSubresourceLayers callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkImageSubresourceLayers malloc(MemoryStack stack)

Returns a new VkImageSubresourceLayers instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageSubresourceLayers calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nbaseArrayLayer

public static int nbaseArrayLayer(long struct)

Unsafe version of baseArrayLayer().

nlayerCount

public static int nlayerCount(long struct)

Unsafe version of layerCount().

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.

nbaseArrayLayer

public static void nbaseArrayLayer(long struct,
 int value)

Unsafe version of baseArrayLayer.

nlayerCount

public static void nlayerCount(long struct,
 int value)

Unsafe version of layerCount.