Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageCompressionPropertiesEXT

extends Struct<VkImageCompressionPropertiesEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Compression properties of an image.
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
IMAGECOMPRESSIONFIXEDRATEFLAGS

The struct member offsets.

public static final int
IMAGECOMPRESSIONFLAGS

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
public
VkImageCompressionPropertiesEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImageCompressionPropertiesEXT
calloc()

Returns a new VkImageCompressionPropertiesEXT instance allocated with memCalloc.

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

Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkImageCompressionPropertiesEXT
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 VkImageCompressionPropertiesEXT
create()

Returns a new VkImageCompressionPropertiesEXT instance allocated with BufferUtils.

public static VkImageCompressionPropertiesEXT
create(long address)

Returns a new VkImageCompressionPropertiesEXT instance for the specified memory address.

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

Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImageCompressionPropertiesEXT.Buffer instance at the specified memory.

public static VkImageCompressionPropertiesEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
imageCompressionFixedRateFlags()

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

public int
imageCompressionFlags()

returns a value describing the compression controls that apply to the image.

public static VkImageCompressionPropertiesEXT
malloc()

Returns a new VkImageCompressionPropertiesEXT instance allocated with memAlloc.

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

Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkImageCompressionPropertiesEXT instance allocated on the specified MemoryStack.

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

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

public static int
public static int
nimageCompressionFlags(long struct)

Unsafe version of imageCompressionFlags.

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 long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageCompressionPropertiesEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkImageCompressionPropertiesEXT
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkImageCompressionPropertiesEXT

Returns:

this struct
set
(VkImageCompressionPropertiesEXT
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 VkImageCompressionPropertiesEXT
sType(int value)

Sets the specified value to the sType field.

public VkImageCompressionPropertiesEXT
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.

IMAGECOMPRESSIONFIXEDRATEFLAGSback to summary
public static final int IMAGECOMPRESSIONFIXEDRATEFLAGS

The struct member offsets.

IMAGECOMPRESSIONFLAGSback to summary
public static final int IMAGECOMPRESSIONFLAGS

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

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

callocback to summary
public static VkImageCompressionPropertiesEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageCompressionPropertiesEXT calloc(MemoryStack stack)

Returns a new VkImageCompressionPropertiesEXT 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 VkImageCompressionPropertiesEXT.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected VkImageCompressionPropertiesEXT 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 VkImageCompressionPropertiesEXT create()

Returns a new VkImageCompressionPropertiesEXT instance allocated with BufferUtils.

createback to summary
public static VkImageCompressionPropertiesEXT create(long address)

Returns a new VkImageCompressionPropertiesEXT instance for the specified memory address.

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

Returns a new VkImageCompressionPropertiesEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageCompressionPropertiesEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageCompressionPropertiesEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageCompressionFixedRateFlagsback to summary
public int imageCompressionFixedRateFlags()

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

Annotations
@NativeType:VkImageCompressionFixedRateFlagsEXT
imageCompressionFlagsback to summary
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.

Annotations
@NativeType:VkImageCompressionFlagsEXT
mallocback to summary
public static VkImageCompressionPropertiesEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageCompressionPropertiesEXT malloc(MemoryStack stack)

Returns a new VkImageCompressionPropertiesEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nimageCompressionFixedRateFlagsback to summary
public static int nimageCompressionFixedRateFlags(long struct)

Unsafe version of imageCompressionFixedRateFlags.

nimageCompressionFlagsback to summary
public static int nimageCompressionFlags(long struct)

Unsafe version of imageCompressionFlags.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkImageCompressionPropertiesEXT set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkImageCompressionPropertiesEXT set(VkImageCompressionPropertiesEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImageCompressionPropertiesEXT

the source struct

Returns:VkImageCompressionPropertiesEXT

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 VkImageCompressionPropertiesEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_PROPERTIES_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkImageCompressionPropertiesEXT.Buffer

extends StructBuffer<VkImageCompressionPropertiesEXT, VkImageCompressionPropertiesEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkImageCompressionPropertiesEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageCompressionPropertiesEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageCompressionPropertiesEXT.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
protected VkImageCompressionPropertiesEXT
public int
public int
public long

Returns:

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

public VkImageCompressionPropertiesEXT.Buffer
pNext(long value)

Sets the specified value to the VkImageCompressionPropertiesEXT#pNext field.

protected VkImageCompressionPropertiesEXT.Buffer
public int

Returns:

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

public VkImageCompressionPropertiesEXT.Buffer
sType(int value)

Sets the specified value to the VkImageCompressionPropertiesEXT#sType field.

public VkImageCompressionPropertiesEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageCompressionPropertiesEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImageCompressionPropertiesEXT.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 VkImageCompressionPropertiesEXT#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

getElementFactoryback to summary
protected VkImageCompressionPropertiesEXT getElementFactory()

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

Annotations
@Override
imageCompressionFixedRateFlagsback to summary
public int imageCompressionFixedRateFlags()
Returns:int

the value of the VkImageCompressionPropertiesEXT#imageCompressionFixedRateFlags field.

Annotations
@NativeType:VkImageCompressionFixedRateFlagsEXT
imageCompressionFlagsback to summary
public int imageCompressionFlags()
Returns:int

the value of the VkImageCompressionPropertiesEXT#imageCompressionFlags field.

Annotations
@NativeType:VkImageCompressionFlagsEXT
pNextback to summary
public long pNext()
Returns:long

the value of the VkImageCompressionPropertiesEXT#pNext field.

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

Sets the specified value to the VkImageCompressionPropertiesEXT#pNext field.

selfback to summary
protected VkImageCompressionPropertiesEXT.Buffer self()

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

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

the value of the VkImageCompressionPropertiesEXT#sType field.

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

Sets the specified value to the VkImageCompressionPropertiesEXT#sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_COMPRESSION_PROPERTIES_EXT value to the VkImageCompressionPropertiesEXT#sType field.