Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageCompressionControlEXT

extends Struct<VkImageCompressionControlEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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
Valid Usage (Implicit)
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkImageCompressionControlEXT.Buffer

An array of VkImageCompressionControlEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COMPRESSIONCONTROLPLANECOUNT

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
PFIXEDRATEFLAGS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkImageCompressionControlEXT(long address, ByteBuffer container)

public
VkImageCompressionControlEXT(ByteBuffer container)

Creates a VkImageCompressionControlEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkImageCompressionControlEXT
calloc()

Returns a new VkImageCompressionControlEXT instance allocated with memCalloc.

public static VkImageCompressionControlEXT.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkImageCompressionControlEXT.Buffer instance allocated with memCalloc.

public static VkImageCompressionControlEXT
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkImageCompressionControlEXT.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public int
compressionControlPlaneCount()

the number of entries in the pFixedRateFlags array.

public VkImageCompressionControlEXT
compressionControlPlaneCount(int value)

Sets the specified value to the compressionControlPlaneCount field.

protected VkImageCompressionControlEXT
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkImageCompressionControlEXT
create()

Returns a new VkImageCompressionControlEXT instance allocated with BufferUtils.

public static VkImageCompressionControlEXT
create(long address)

Returns a new VkImageCompressionControlEXT instance for the specified memory address.

public static VkImageCompressionControlEXT.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkImageCompressionControlEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImageCompressionControlEXT.Buffer instance at the specified memory.

public static VkImageCompressionControlEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkImageCompressionFlagBitsEXT describing compression controls for the image.

public VkImageCompressionControlEXT
flags(int value)

Sets the specified value to the flags field.

public static VkImageCompressionControlEXT
malloc()

Returns a new VkImageCompressionControlEXT instance allocated with memAlloc.

public static VkImageCompressionControlEXT.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkImageCompressionControlEXT.Buffer instance allocated with memAlloc.

public static VkImageCompressionControlEXT
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkImageCompressionControlEXT instance allocated on the specified MemoryStack.

public static VkImageCompressionControlEXT.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static int
ncompressionControlPlaneCount(long struct)

Unsafe version of compressionControlPlaneCount.

public static void
ncompressionControlPlaneCount(long struct, int value)

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

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static IntBuffer
npFixedRateFlags(long struct)

Unsafe version of pFixedRateFlags.

public static void
npFixedRateFlags(long struct, IntBuffer value)

Unsafe version of pFixedRateFlags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public IntBuffer
pFixedRateFlags()

NULL or a pointer to an array of VkImageCompressionFixedRateFlagsEXT bitfields describing allowed fixed-rate compression rates of each image plane.

public VkImageCompressionControlEXT
pFixedRateFlags(IntBuffer value)

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

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageCompressionControlEXT
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkImageCompressionControlEXT

Returns:

this struct
set(VkImageCompressionControlEXT
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkImageCompressionControlEXT
sType(int value)

Sets the specified value to the sType field.

public VkImageCompressionControlEXT
sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

COMPRESSIONCONTROLPLANECOUNTback to summary
public static final int COMPRESSIONCONTROLPLANECOUNT

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PFIXEDRATEFLAGSback to summary
public static final int PFIXEDRATEFLAGS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkImageCompressionControlEXTback to summary
protected VkImageCompressionControlEXT(long address, ByteBuffer container)
VkImageCompressionControlEXTback to summary
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 Detail

callocback to summary
public static VkImageCompressionControlEXT calloc()

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

callocback to summary
public static VkImageCompressionControlEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageCompressionControlEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkImageCompressionControlEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

compressionControlPlaneCountback to summary
public int compressionControlPlaneCount()

the number of entries in the pFixedRateFlags array.

Annotations
@NativeType:uint32_t
compressionControlPlaneCountback to summary
public VkImageCompressionControlEXT compressionControlPlaneCount(int value)

Sets the specified value to the compressionControlPlaneCount field.

createback to summary
protected VkImageCompressionControlEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkImageCompressionControlEXT create()

Returns a new VkImageCompressionControlEXT instance allocated with BufferUtils.

createback to summary
public static VkImageCompressionControlEXT create(long address)

Returns a new VkImageCompressionControlEXT instance for the specified memory address.

createback to summary
public static VkImageCompressionControlEXT.Buffer create(int capacity)

Returns a new VkImageCompressionControlEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageCompressionControlEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageCompressionControlEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkImageCompressionControlEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkImageCompressionFlagBitsEXT describing compression controls for the image.

Annotations
@NativeType:VkImageCompressionFlagsEXT
flagsback to summary
public VkImageCompressionControlEXT flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkImageCompressionControlEXT malloc()

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

mallocback to summary
public static VkImageCompressionControlEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageCompressionControlEXT malloc(MemoryStack stack)

Returns a new VkImageCompressionControlEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkImageCompressionControlEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncompressionControlPlaneCountback to summary
public static int ncompressionControlPlaneCount(long struct)

Unsafe version of compressionControlPlaneCount.

ncompressionControlPlaneCountback to summary
public static void ncompressionControlPlaneCount(long struct, int value)

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

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

npFixedRateFlagsback to summary
public static IntBuffer npFixedRateFlags(long struct)

Unsafe version of pFixedRateFlags.

Annotations
@Nullable
npFixedRateFlagsback to summary
public static void npFixedRateFlags(long struct, IntBuffer value)

Unsafe version of pFixedRateFlags.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pFixedRateFlagsback to summary
public 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.

Annotations
@Nullable
@NativeType:VkImageCompressionFixedRateFlagsEXT *
pFixedRateFlagsback to summary
public VkImageCompressionControlEXT pFixedRateFlags(IntBuffer value)

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

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkImageCompressionControlEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkImageCompressionControlEXT set(int sType, long pNext, int flags, int compressionControlPlaneCount, IntBuffer pFixedRateFlags)

Initializes this struct with the specified values.

setback to summary
public VkImageCompressionControlEXT set(VkImageCompressionControlEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImageCompressionControlEXT

the source struct

Returns:VkImageCompressionControlEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageCompressionControlEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkImageCompressionControlEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkImageCompressionControlEXT.Buffer

extends StructBuffer<VkImageCompressionControlEXT, VkImageCompressionControlEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkImageCompressionControlEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageCompressionControlEXT
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageCompressionControlEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkImageCompressionControlEXT#compressionControlPlaneCount field.
compressionControlPlaneCount()

public VkImageCompressionControlEXT.Buffer
compressionControlPlaneCount(int value)

Sets the specified value to the VkImageCompressionControlEXT#compressionControlPlaneCount field.

public int

Returns:

the value of the VkImageCompressionControlEXT#flags field.
flags()

public VkImageCompressionControlEXT.Buffer
flags(int value)

Sets the specified value to the VkImageCompressionControlEXT#flags field.

protected VkImageCompressionControlEXT
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the VkImageCompressionControlEXT#pFixedRateFlags field.
pFixedRateFlags()

public VkImageCompressionControlEXT.Buffer
pFixedRateFlags(IntBuffer value)

Sets the address of the specified IntBuffer to the VkImageCompressionControlEXT#pFixedRateFlags field.

public long

Returns:

the value of the VkImageCompressionControlEXT#pNext field.
pNext()

public VkImageCompressionControlEXT.Buffer
pNext(long value)

Sets the specified value to the VkImageCompressionControlEXT#pNext field.

protected VkImageCompressionControlEXT.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkImageCompressionControlEXT#sType field.
sType()

public VkImageCompressionControlEXT.Buffer
sType(int value)

Sets the specified value to the VkImageCompressionControlEXT#sType field.

public VkImageCompressionControlEXT.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT value to the VkImageCompressionControlEXT#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageCompressionControlEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImageCompressionControlEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkImageCompressionControlEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

compressionControlPlaneCountback to summary
public int compressionControlPlaneCount()
Returns:int

the value of the VkImageCompressionControlEXT#compressionControlPlaneCount field.

Annotations
@NativeType:uint32_t
compressionControlPlaneCountback to summary
public VkImageCompressionControlEXT.Buffer compressionControlPlaneCount(int value)

Sets the specified value to the VkImageCompressionControlEXT#compressionControlPlaneCount field.

flagsback to summary
public int flags()
Returns:int

the value of the VkImageCompressionControlEXT#flags field.

Annotations
@NativeType:VkImageCompressionFlagsEXT
flagsback to summary
public VkImageCompressionControlEXT.Buffer flags(int value)

Sets the specified value to the VkImageCompressionControlEXT#flags field.

getElementFactoryback to summary
protected VkImageCompressionControlEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pFixedRateFlagsback to summary
public IntBuffer pFixedRateFlags()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the VkImageCompressionControlEXT#pFixedRateFlags field.

Annotations
@Nullable
@NativeType:VkImageCompressionFixedRateFlagsEXT *
pFixedRateFlagsback to summary
public VkImageCompressionControlEXT.Buffer pFixedRateFlags(IntBuffer value)

Sets the address of the specified IntBuffer to the VkImageCompressionControlEXT#pFixedRateFlags field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImageCompressionControlEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkImageCompressionControlEXT.Buffer pNext(long value)

Sets the specified value to the VkImageCompressionControlEXT#pNext field.

selfback to summary
protected VkImageCompressionControlEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkImageCompressionControlEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImageCompressionControlEXT.Buffer sType(int value)

Sets the specified value to the VkImageCompressionControlEXT#sType field.

sType$Defaultback to summary
public VkImageCompressionControlEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT value to the VkImageCompressionControlEXT#sType field.