Package org.lwjgl.vulkan

Class VkAndroidHardwareBufferFormatProperties2ANDROID

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAndroidHardwareBufferFormatProperties2ANDROID>

org.lwjgl.vulkan.VkAndroidHardwareBufferFormatProperties2ANDROID

All Implemented Interfaces:

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

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

Structure describing the image format properties of an Android hardware buffer.

Description

The bits reported in formatFeatures must include the bits reported in the corresponding fields of VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_2_ANDROID

See Also

VkComponentMapping

Layout

 struct VkAndroidHardwareBufferFormatProperties2ANDROID {
     VkStructureType sType();
     void * pNext();
     VkFormat format();
     uint64_t externalFormat();
     VkFormatFeatureFlags2 formatFeatures();
     VkComponentMapping samplerYcbcrConversionComponents();
     VkSamplerYcbcrModelConversion suggestedYcbcrModel();
     VkSamplerYcbcrRange suggestedYcbcrRange();
     VkChromaLocation suggestedXChromaOffset();
     VkChromaLocation suggestedYChromaOffset();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer	An array of VkAndroidHardwareBufferFormatProperties2ANDROID 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	EXTERNALFORMAT	The struct member offsets.
static final int	FORMAT	The struct member offsets.
static final int	FORMATFEATURES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SAMPLERYCBCRCONVERSIONCOMPONENTS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	SUGGESTEDXCHROMAOFFSET	The struct member offsets.
static final int	SUGGESTEDYCBCRMODEL	The struct member offsets.
static final int	SUGGESTEDYCBCRRANGE	The struct member offsets.
static final int	SUGGESTEDYCHROMAOFFSET	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
VkAndroidHardwareBufferFormatProperties2ANDROID(ByteBuffer container)	Creates a VkAndroidHardwareBufferFormatProperties2ANDROID instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkAndroidHardwareBufferFormatProperties2ANDROID	calloc()	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance allocated with memCalloc.
static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer	calloc(int capacity)	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer instance allocated with memCalloc.
static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAndroidHardwareBufferFormatProperties2ANDROID	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAndroidHardwareBufferFormatProperties2ANDROID	create()	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance allocated with BufferUtils.
static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer	create(int capacity)	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer instance allocated with BufferUtils.
static VkAndroidHardwareBufferFormatProperties2ANDROID	create(long address)	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance for the specified memory address.
static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer	create(long address, int capacity)	Create a VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer instance at the specified memory.
static @Nullable VkAndroidHardwareBufferFormatProperties2ANDROID	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	externalFormat()	an implementation-defined external format identifier for use with VkExternalFormatANDROID.
int	format()	the Vulkan format corresponding to the Android hardware buffer’s format, or FORMAT_UNDEFINED if there is not an equivalent Vulkan format.
long	formatFeatures()	describes the capabilities of this external format when used with an image bound to memory imported from buffer.
static VkAndroidHardwareBufferFormatProperties2ANDROID	malloc()	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance allocated with memAlloc.
static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer	malloc(int capacity)	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer instance allocated with memAlloc.
static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer instance allocated on the specified MemoryStack.
static VkAndroidHardwareBufferFormatProperties2ANDROID	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance allocated on the specified MemoryStack.
static long	nexternalFormat(long struct)	Unsafe version of externalFormat().
static int	nformat(long struct)	Unsafe version of format().
static long	nformatFeatures(long struct)	Unsafe version of formatFeatures().
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkComponentMapping	nsamplerYcbcrConversionComponents(long struct)	Unsafe version of samplerYcbcrConversionComponents().
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nsuggestedXChromaOffset(long struct)	Unsafe version of suggestedXChromaOffset().
static int	nsuggestedYcbcrModel(long struct)	Unsafe version of suggestedYcbcrModel().
static int	nsuggestedYcbcrRange(long struct)	Unsafe version of suggestedYcbcrRange().
static int	nsuggestedYChromaOffset(long struct)	Unsafe version of suggestedYChromaOffset().
long	pNext()	NULL or a pointer to a structure extending this structure.
VkAndroidHardwareBufferFormatProperties2ANDROID	pNext(long value)	Sets the specified value to the pNext() field.
VkComponentMapping	samplerYcbcrConversionComponents()	the component swizzle that should be used in VkSamplerYcbcrConversionCreateInfo.
VkAndroidHardwareBufferFormatProperties2ANDROID	set(int sType, long pNext)	Initializes this struct with the specified values.
VkAndroidHardwareBufferFormatProperties2ANDROID	set(VkAndroidHardwareBufferFormatProperties2ANDROID src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAndroidHardwareBufferFormatProperties2ANDROID	sType(int value)	Sets the specified value to the sType() field.
VkAndroidHardwareBufferFormatProperties2ANDROID	sType$Default()	Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_2_ANDROID value to the sType() field.
int	suggestedXChromaOffset()	a suggested X chroma offset to use in VkSamplerYcbcrConversionCreateInfo.
int	suggestedYcbcrModel()	a suggested color model to use in the VkSamplerYcbcrConversionCreateInfo.
int	suggestedYcbcrRange()	a suggested numerical value range to use in VkSamplerYcbcrConversionCreateInfo.
int	suggestedYChromaOffset()	a suggested Y chroma offset to use in VkSamplerYcbcrConversionCreateInfo.

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.

FORMAT

public static final int FORMAT

The struct member offsets.

EXTERNALFORMAT

public static final int EXTERNALFORMAT

The struct member offsets.

FORMATFEATURES

public static final int FORMATFEATURES

The struct member offsets.

SAMPLERYCBCRCONVERSIONCOMPONENTS

public static final int SAMPLERYCBCRCONVERSIONCOMPONENTS

The struct member offsets.

SUGGESTEDYCBCRMODEL

public static final int SUGGESTEDYCBCRMODEL

The struct member offsets.

SUGGESTEDYCBCRRANGE

public static final int SUGGESTEDYCBCRRANGE

The struct member offsets.

SUGGESTEDXCHROMAOFFSET

public static final int SUGGESTEDXCHROMAOFFSET

The struct member offsets.

SUGGESTEDYCHROMAOFFSET

public static final int SUGGESTEDYCHROMAOFFSET

The struct member offsets.

Constructor Details

VkAndroidHardwareBufferFormatProperties2ANDROID

public VkAndroidHardwareBufferFormatProperties2ANDROID(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

format

public int format()

the Vulkan format corresponding to the Android hardware buffer’s format, or FORMAT_UNDEFINED if there is not an equivalent Vulkan format.

externalFormat

public long externalFormat()

an implementation-defined external format identifier for use with VkExternalFormatANDROID. It must not be zero.

formatFeatures

public long formatFeatures()

describes the capabilities of this external format when used with an image bound to memory imported from buffer.

samplerYcbcrConversionComponents

public VkComponentMapping samplerYcbcrConversionComponents()

the component swizzle that should be used in VkSamplerYcbcrConversionCreateInfo.

suggestedYcbcrModel

public int suggestedYcbcrModel()

a suggested color model to use in the VkSamplerYcbcrConversionCreateInfo.

suggestedYcbcrRange

public int suggestedYcbcrRange()

a suggested numerical value range to use in VkSamplerYcbcrConversionCreateInfo.

suggestedXChromaOffset

public int suggestedXChromaOffset()

a suggested X chroma offset to use in VkSamplerYcbcrConversionCreateInfo.

suggestedYChromaOffset

public int suggestedYChromaOffset()

a suggested Y chroma offset to use in VkSamplerYcbcrConversionCreateInfo.

sType

public VkAndroidHardwareBufferFormatProperties2ANDROID sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAndroidHardwareBufferFormatProperties2ANDROID sType$Default()

Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_2_ANDROID value to the sType() field.

pNext

public VkAndroidHardwareBufferFormatProperties2ANDROID pNext(long value)

Sets the specified value to the pNext() field.

set

public VkAndroidHardwareBufferFormatProperties2ANDROID set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkAndroidHardwareBufferFormatProperties2ANDROID set(VkAndroidHardwareBufferFormatProperties2ANDROID src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAndroidHardwareBufferFormatProperties2ANDROID malloc()

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

calloc

public static VkAndroidHardwareBufferFormatProperties2ANDROID calloc()

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

create

public static VkAndroidHardwareBufferFormatProperties2ANDROID create()

Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance allocated with BufferUtils.

create

public static VkAndroidHardwareBufferFormatProperties2ANDROID create(long address)

Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance for the specified memory address.

createSafe

public static @Nullable VkAndroidHardwareBufferFormatProperties2ANDROID createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer create(int capacity)

Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAndroidHardwareBufferFormatProperties2ANDROID.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAndroidHardwareBufferFormatProperties2ANDROID instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nformat

public static int nformat(long struct)

Unsafe version of format().

nexternalFormat

public static long nexternalFormat(long struct)

Unsafe version of externalFormat().

nformatFeatures

public static long nformatFeatures(long struct)

Unsafe version of formatFeatures().

nsamplerYcbcrConversionComponents

public static VkComponentMapping nsamplerYcbcrConversionComponents(long struct)

Unsafe version of samplerYcbcrConversionComponents().

nsuggestedYcbcrModel

public static int nsuggestedYcbcrModel(long struct)

Unsafe version of suggestedYcbcrModel().

nsuggestedYcbcrRange

public static int nsuggestedYcbcrRange(long struct)

Unsafe version of suggestedYcbcrRange().

nsuggestedXChromaOffset

public static int nsuggestedXChromaOffset(long struct)

Unsafe version of suggestedXChromaOffset().

nsuggestedYChromaOffset

public static int nsuggestedYChromaOffset(long struct)

Unsafe version of suggestedYChromaOffset().

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.