Package org.lwjgl.vulkan

Class VkImageViewASTCDecodeModeEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageViewASTCDecodeModeEXT>

org.lwjgl.vulkan.VkImageViewASTCDecodeModeEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkImageViewASTCDecodeModeEXT
extends Struct<VkImageViewASTCDecodeModeEXT>
implements NativeResource

Structure describing the ASTC decode mode for an image view.

Valid Usage

• decodeMode must be one of FORMAT_R16G16B16A16_SFLOAT, FORMAT_R8G8B8A8_UNORM, or FORMAT_E5B9G9R9_UFLOAT_PACK32
• If the decodeModeSharedExponent feature is not enabled, decodeMode must not be FORMAT_E5B9G9R9_UFLOAT_PACK32
• If decodeMode is FORMAT_R8G8B8A8_UNORM the image view must not include blocks using any of the ASTC HDR modes
• format of the image view must be one of the ASTC Compressed Image Formats

If format uses sRGB encoding then the decodeMode has no effect.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_VIEW_ASTC_DECODE_MODE_EXT
• decodeMode must be a valid VkFormat value

Layout

 struct VkImageViewASTCDecodeModeEXT {
     VkStructureType sType();
     void const * pNext();
     VkFormat decodeMode();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageViewASTCDecodeModeEXT.Buffer	An array of VkImageViewASTCDecodeModeEXT 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	DECODEMODE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageViewASTCDecodeModeEXT	calloc()	Returns a new VkImageViewASTCDecodeModeEXT instance allocated with memCalloc.
static VkImageViewASTCDecodeModeEXT.Buffer	calloc(int capacity)	Returns a new VkImageViewASTCDecodeModeEXT.Buffer instance allocated with memCalloc.
static VkImageViewASTCDecodeModeEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkImageViewASTCDecodeModeEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewASTCDecodeModeEXT	calloc(MemoryStack stack)	Returns a new VkImageViewASTCDecodeModeEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewASTCDecodeModeEXT	callocStack()	Deprecated.
static VkImageViewASTCDecodeModeEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkImageViewASTCDecodeModeEXT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageViewASTCDecodeModeEXT	callocStack(MemoryStack stack)	Deprecated.
static VkImageViewASTCDecodeModeEXT	create()	Returns a new VkImageViewASTCDecodeModeEXT instance allocated with BufferUtils.
static VkImageViewASTCDecodeModeEXT.Buffer	create(int capacity)	Returns a new VkImageViewASTCDecodeModeEXT.Buffer instance allocated with BufferUtils.
static VkImageViewASTCDecodeModeEXT	create(long address)	Returns a new VkImageViewASTCDecodeModeEXT instance for the specified memory address.
static VkImageViewASTCDecodeModeEXT.Buffer	create(long address, int capacity)	Create a VkImageViewASTCDecodeModeEXT.Buffer instance at the specified memory.
static VkImageViewASTCDecodeModeEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkImageViewASTCDecodeModeEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	decodeMode()	the intermediate format used to decode ASTC compressed formats.
VkImageViewASTCDecodeModeEXT	decodeMode(int value)	Sets the specified value to the decodeMode() field.
static VkImageViewASTCDecodeModeEXT	malloc()	Returns a new VkImageViewASTCDecodeModeEXT instance allocated with memAlloc.
static VkImageViewASTCDecodeModeEXT.Buffer	malloc(int capacity)	Returns a new VkImageViewASTCDecodeModeEXT.Buffer instance allocated with memAlloc.
static VkImageViewASTCDecodeModeEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkImageViewASTCDecodeModeEXT.Buffer instance allocated on the specified MemoryStack.
static VkImageViewASTCDecodeModeEXT	malloc(MemoryStack stack)	Returns a new VkImageViewASTCDecodeModeEXT instance allocated on the specified MemoryStack.
static VkImageViewASTCDecodeModeEXT	mallocStack()	Deprecated.
static VkImageViewASTCDecodeModeEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageViewASTCDecodeModeEXT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageViewASTCDecodeModeEXT	mallocStack(MemoryStack stack)	Deprecated.
static int	ndecodeMode(long struct)	Unsafe version of decodeMode().
static void	ndecodeMode(long struct, int value)	Unsafe version of decodeMode.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImageViewASTCDecodeModeEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkImageViewASTCDecodeModeEXT	set(int sType, long pNext, int decodeMode)	Initializes this struct with the specified values.
VkImageViewASTCDecodeModeEXT	set(VkImageViewASTCDecodeModeEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkImageViewASTCDecodeModeEXT	sType(int value)	Sets the specified value to the sType() field.
VkImageViewASTCDecodeModeEXT	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_VIEW_ASTC_DECODE_MODE_EXT value to the sType() field.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

DECODEMODE

public static final int DECODEMODE

The struct member offsets.

Constructor Details

VkImageViewASTCDecodeModeEXT

public VkImageViewASTCDecodeModeEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

decodeMode

public int decodeMode()

the intermediate format used to decode ASTC compressed formats.

sType

public VkImageViewASTCDecodeModeEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageViewASTCDecodeModeEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_ASTC_DECODE_MODE_EXT value to the sType() field.

pNext

public VkImageViewASTCDecodeModeEXT pNext(long value)

Sets the specified value to the pNext() field.

decodeMode

public VkImageViewASTCDecodeModeEXT decodeMode(int value)

Sets the specified value to the decodeMode() field.

set

public VkImageViewASTCDecodeModeEXT set(int sType,
 long pNext,
 int decodeMode)

Initializes this struct with the specified values.

set

public VkImageViewASTCDecodeModeEXT set(VkImageViewASTCDecodeModeEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageViewASTCDecodeModeEXT malloc()

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

calloc

public static VkImageViewASTCDecodeModeEXT calloc()

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

create

public static VkImageViewASTCDecodeModeEXT create()

Returns a new VkImageViewASTCDecodeModeEXT instance allocated with BufferUtils.

create

public static VkImageViewASTCDecodeModeEXT create(long address)

Returns a new VkImageViewASTCDecodeModeEXT instance for the specified memory address.

createSafe

@Nullable
public static VkImageViewASTCDecodeModeEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageViewASTCDecodeModeEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageViewASTCDecodeModeEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageViewASTCDecodeModeEXT.Buffer create(int capacity)

Returns a new VkImageViewASTCDecodeModeEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageViewASTCDecodeModeEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageViewASTCDecodeModeEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageViewASTCDecodeModeEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageViewASTCDecodeModeEXT mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageViewASTCDecodeModeEXT callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkImageViewASTCDecodeModeEXT malloc(MemoryStack stack)

Returns a new VkImageViewASTCDecodeModeEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageViewASTCDecodeModeEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndecodeMode

public static int ndecodeMode(long struct)

Unsafe version of decodeMode().

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.

ndecodeMode

public static void ndecodeMode(long struct,
 int value)

Unsafe version of decodeMode.