Package org.lwjgl.vulkan

Class VkImageCompressionControlEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageCompressionControlEXT>

org.lwjgl.vulkan.VkImageCompressionControlEXT

All Implemented Interfaces:

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

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

Specify image compression properties.

Description

If enabled, fixed-rate compression is done in an implementation-defined manner and may be applied at block granularity. In that case, a write to an individual texel may modify the value of other texels in the same block.

Valid Usage

• flags must be one of IMAGE_COMPRESSION_DEFAULT_EXT, IMAGE_COMPRESSION_FIXED_RATE_DEFAULT_EXT, IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT, or IMAGE_COMPRESSION_DISABLED_EXT
• If flags includes IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT, pFixedRateFlags must not be NULL

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT

Note

Some combinations of compression properties may not be supported. For example, some implementations may not support different fixed-rate compression rates per plane of a multi-planar format and will not be able to enable fixed-rate compression for any plane if the requested rates differ.

Layout

 struct VkImageCompressionControlEXT {
     VkStructureType sType();
     void const * pNext();
     VkImageCompressionFlagsEXT flags();
     uint32_t compressionControlPlaneCount();
     VkImageCompressionFixedRateFlagsEXT * pFixedRateFlags();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkImageCompressionControlEXT	calloc()	Returns a new VkImageCompressionControlEXT instance allocated with memCalloc.
static VkImageCompressionControlEXT.Buffer	calloc(int capacity)	Returns a new VkImageCompressionControlEXT.Buffer instance allocated with memCalloc.
static VkImageCompressionControlEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCompressionControlEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageCompressionControlEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCompressionControlEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	compressionControlPlaneCount()	the number of entries in the pFixedRateFlags array.
VkImageCompressionControlEXT	compressionControlPlaneCount(int value)	Sets the specified value to the compressionControlPlaneCount() field.
static VkImageCompressionControlEXT	create()	Returns a new VkImageCompressionControlEXT instance allocated with BufferUtils.
static VkImageCompressionControlEXT.Buffer	create(int capacity)	Returns a new VkImageCompressionControlEXT.Buffer instance allocated with BufferUtils.
static VkImageCompressionControlEXT	create(long address)	Returns a new VkImageCompressionControlEXT instance for the specified memory address.
static VkImageCompressionControlEXT.Buffer	create(long address, int capacity)	Create a VkImageCompressionControlEXT.Buffer instance at the specified memory.
static @Nullable VkImageCompressionControlEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageCompressionControlEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkImageCompressionFlagBitsEXT describing compression controls for the image.
VkImageCompressionControlEXT	flags(int value)	Sets the specified value to the flags() field.
static VkImageCompressionControlEXT	malloc()	Returns a new VkImageCompressionControlEXT instance allocated with memAlloc.
static VkImageCompressionControlEXT.Buffer	malloc(int capacity)	Returns a new VkImageCompressionControlEXT.Buffer instance allocated with memAlloc.
static VkImageCompressionControlEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCompressionControlEXT.Buffer instance allocated on the specified MemoryStack.
static VkImageCompressionControlEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageCompressionControlEXT instance allocated on the specified MemoryStack.
static int	ncompressionControlPlaneCount(long struct)	Unsafe version of compressionControlPlaneCount().
static void	ncompressionControlPlaneCount(long struct, int value)	Sets the specified value to the compressionControlPlaneCount field of the specified struct.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static @Nullable IntBuffer	npFixedRateFlags(long struct)	Unsafe version of pFixedRateFlags.
static void	npFixedRateFlags(long struct, @Nullable IntBuffer value)	Unsafe version of pFixedRateFlags.
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.
@Nullable IntBuffer	pFixedRateFlags()	NULL or a pointer to an array of VkImageCompressionFixedRateFlagsEXT bitfields describing allowed fixed-rate compression rates of each image plane.
VkImageCompressionControlEXT	pFixedRateFlags(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pFixedRateFlags() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImageCompressionControlEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkImageCompressionControlEXT	set(int sType, long pNext, int flags, int compressionControlPlaneCount, @Nullable IntBuffer pFixedRateFlags)	Initializes this struct with the specified values.
VkImageCompressionControlEXT	set(VkImageCompressionControlEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImageCompressionControlEXT	sType(int value)	Sets the specified value to the sType() field.
VkImageCompressionControlEXT	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_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.

FLAGS

public static final int FLAGS

The struct member offsets.

COMPRESSIONCONTROLPLANECOUNT

public static final int COMPRESSIONCONTROLPLANECOUNT

The struct member offsets.

PFIXEDRATEFLAGS

public static final int PFIXEDRATEFLAGS

The struct member offsets.

Constructor Details

VkImageCompressionControlEXT

public VkImageCompressionControlEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

a bitmask of VkImageCompressionFlagBitsEXT describing compression controls for the image.

compressionControlPlaneCount

public int compressionControlPlaneCount()

the number of entries in the pFixedRateFlags array.

pFixedRateFlags

public @Nullable IntBuffer pFixedRateFlags()

NULL or a pointer to an array of VkImageCompressionFixedRateFlagsEXT bitfields describing allowed fixed-rate compression rates of each image plane. It is ignored if flags does not include IMAGE_COMPRESSION_FIXED_RATE_EXPLICIT_EXT.

sType

public VkImageCompressionControlEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageCompressionControlEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT value to the sType() field.

pNext

public VkImageCompressionControlEXT pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkImageCompressionControlEXT flags(int value)

Sets the specified value to the flags() field.

compressionControlPlaneCount

public VkImageCompressionControlEXT compressionControlPlaneCount(int value)

Sets the specified value to the compressionControlPlaneCount() field.

pFixedRateFlags

public VkImageCompressionControlEXT pFixedRateFlags(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pFixedRateFlags() field.

set

public VkImageCompressionControlEXT set(int sType,
 long pNext,
 int flags,
 int compressionControlPlaneCount,
 @Nullable IntBuffer pFixedRateFlags)

Initializes this struct with the specified values.

set

public VkImageCompressionControlEXT set(VkImageCompressionControlEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageCompressionControlEXT malloc()

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

calloc

public static VkImageCompressionControlEXT calloc()

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

create

public static VkImageCompressionControlEXT create()

Returns a new VkImageCompressionControlEXT instance allocated with BufferUtils.

create

public static VkImageCompressionControlEXT create(long address)

Returns a new VkImageCompressionControlEXT instance for the specified memory address.

createSafe

public static @Nullable VkImageCompressionControlEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageCompressionControlEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageCompressionControlEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageCompressionControlEXT.Buffer create(int capacity)

Returns a new VkImageCompressionControlEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageCompressionControlEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkImageCompressionControlEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

ncompressionControlPlaneCount

public static int ncompressionControlPlaneCount(long struct)

Unsafe version of compressionControlPlaneCount().

npFixedRateFlags

public static @Nullable IntBuffer npFixedRateFlags(long struct)

Unsafe version of pFixedRateFlags.

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

ncompressionControlPlaneCount

public static void ncompressionControlPlaneCount(long struct,
 int value)

Sets the specified value to the compressionControlPlaneCount field of the specified struct.

npFixedRateFlags

public static void npFixedRateFlags(long struct,
 @Nullable IntBuffer value)

Unsafe version of pFixedRateFlags.