Package org.lwjgl.vulkan

Class VkImageCompressionPropertiesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageCompressionPropertiesEXT>

org.lwjgl.vulkan.VkImageCompressionPropertiesEXT

All Implemented Interfaces:

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

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

Compression properties of an image.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_COMPRESSION_PROPERTIES_EXT

Layout

 struct VkImageCompressionPropertiesEXT {
     VkStructureType sType();
     void * pNext();
     VkImageCompressionFlagsEXT imageCompressionFlags();
     VkImageCompressionFixedRateFlagsEXT imageCompressionFixedRateFlags();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkImageCompressionPropertiesEXT	calloc()	Returns a new VkImageCompressionPropertiesEXT instance allocated with memCalloc.
static VkImageCompressionPropertiesEXT.Buffer	calloc(int capacity)	Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated with memCalloc.
static VkImageCompressionPropertiesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageCompressionPropertiesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCompressionPropertiesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageCompressionPropertiesEXT	create()	Returns a new VkImageCompressionPropertiesEXT instance allocated with BufferUtils.
static VkImageCompressionPropertiesEXT.Buffer	create(int capacity)	Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated with BufferUtils.
static VkImageCompressionPropertiesEXT	create(long address)	Returns a new VkImageCompressionPropertiesEXT instance for the specified memory address.
static VkImageCompressionPropertiesEXT.Buffer	create(long address, int capacity)	Create a VkImageCompressionPropertiesEXT.Buffer instance at the specified memory.
static @Nullable VkImageCompressionPropertiesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageCompressionPropertiesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageCompressionFixedRateFlags()	returns a VkImageCompressionFixedRateFlagsEXT value describing the compression rates that apply to the specified aspect of the image.
int	imageCompressionFlags()	returns a value describing the compression controls that apply to the image.
static VkImageCompressionPropertiesEXT	malloc()	Returns a new VkImageCompressionPropertiesEXT instance allocated with memAlloc.
static VkImageCompressionPropertiesEXT.Buffer	malloc(int capacity)	Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated with memAlloc.
static VkImageCompressionPropertiesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated on the specified MemoryStack.
static VkImageCompressionPropertiesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCompressionPropertiesEXT instance allocated on the specified MemoryStack.
static int	nimageCompressionFixedRateFlags(long struct)	Unsafe version of imageCompressionFixedRateFlags().
static int	nimageCompressionFlags(long struct)	Unsafe version of imageCompressionFlags().
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.
VkImageCompressionPropertiesEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkImageCompressionPropertiesEXT	set(int sType, long pNext)	Initializes this struct with the specified values.
VkImageCompressionPropertiesEXT	set(VkImageCompressionPropertiesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImageCompressionPropertiesEXT	sType(int value)	Sets the specified value to the sType() field.
VkImageCompressionPropertiesEXT	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_PROPERTIES_EXT value to the sType() field.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

IMAGECOMPRESSIONFLAGS

public static final int IMAGECOMPRESSIONFLAGS

The struct member offsets.

IMAGECOMPRESSIONFIXEDRATEFLAGS

public static final int IMAGECOMPRESSIONFIXEDRATEFLAGS

The struct member offsets.

Constructor Details

VkImageCompressionPropertiesEXT

public VkImageCompressionPropertiesEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

imageCompressionFlags

public int imageCompressionFlags()

returns a value describing the compression controls that apply to the image. The value will be either IMAGE_COMPRESSION_DEFAULT_EXT to indicate no fixed-rate compression, IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT to indicate fixed-rate compression, or IMAGE_COMPRESSION_DISABLED_EXT to indicate no compression.

imageCompressionFixedRateFlags

public int imageCompressionFixedRateFlags()

returns a VkImageCompressionFixedRateFlagsEXT value describing the compression rates that apply to the specified aspect of the image.

sType

public VkImageCompressionPropertiesEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageCompressionPropertiesEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_PROPERTIES_EXT value to the sType() field.

pNext

public VkImageCompressionPropertiesEXT pNext(long value)

Sets the specified value to the pNext() field.

set

public VkImageCompressionPropertiesEXT set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkImageCompressionPropertiesEXT set(VkImageCompressionPropertiesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageCompressionPropertiesEXT malloc()

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

calloc

public static VkImageCompressionPropertiesEXT calloc()

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

create

public static VkImageCompressionPropertiesEXT create()

Returns a new VkImageCompressionPropertiesEXT instance allocated with BufferUtils.

create

public static VkImageCompressionPropertiesEXT create(long address)

Returns a new VkImageCompressionPropertiesEXT instance for the specified memory address.

createSafe

public static @Nullable VkImageCompressionPropertiesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageCompressionPropertiesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageCompressionPropertiesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageCompressionPropertiesEXT.Buffer create(int capacity)

Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageCompressionPropertiesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkImageCompressionPropertiesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nimageCompressionFlags

public static int nimageCompressionFlags(long struct)

Unsafe version of imageCompressionFlags().

nimageCompressionFixedRateFlags

public static int nimageCompressionFixedRateFlags(long struct)

Unsafe version of imageCompressionFixedRateFlags().

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.