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

Description

If the Android hardware buffer has one of the formats listed in the Format Equivalence table, then format must have the equivalent Vulkan format listed in the table. Otherwise, format may be FORMAT_UNDEFINED, indicating the Android hardware buffer can only be used with an external format.

The formatFeatures member must include FORMAT_FEATURE_SAMPLED_IMAGE_BIT and at least one of FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT or FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT, and should include FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT and FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT.

Note

The formatFeatures member only indicates the features available when using an external-format image created from the Android hardware buffer. Images from Android hardware buffers with a format other than FORMAT_UNDEFINED are subject to the format capabilities obtained from GetPhysicalDeviceFormatProperties2, and GetPhysicalDeviceImageFormatProperties2 with appropriate parameters. These sets of features are independent of each other, e.g. the external format will support sampler Y′C_BC_R conversion even if the non-external format does not, and writing to non-external format images is possible but writing to external format images is not.

Android hardware buffers with the same external format must have the same support for FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT, FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT, FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT, FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT, and FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT. in formatFeatures. Other format features may differ between Android hardware buffers that have the same external format. This allows applications to use the same VkSamplerYcbcrConversion object (and samplers and pipelines created from them) for any Android hardware buffers that have the same external format.

If format is not FORMAT_UNDEFINED, then the value of samplerYcbcrConversionComponents must be valid when used as the components member of VkSamplerYcbcrConversionCreateInfo with that format. If format is FORMAT_UNDEFINED, all members of samplerYcbcrConversionComponents must be the identity swizzle.

Implementations may not always be able to determine the color model, numerical range, or chroma offsets of the image contents, so the values in VkAndroidHardwareBufferFormatPropertiesANDROID are only suggestions. Applications should treat these values as sensible defaults to use in the absence of more reliable information obtained through some other means. If the underlying physical device is also usable via OpenGL ES with the GL_OES_EGL_image_external extension, the implementation should suggest values that will produce similar sampled values as would be obtained by sampling the same external image via samplerExternalOES in OpenGL ES using equivalent sampler parameters.

Note

Since GL_OES_EGL_image_external does not require the same sampling and conversion calculations as Vulkan does, achieving identical results between APIs may not be possible on some implementations.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID

Layout


struct VkAndroidHardwareBufferFormatPropertiesANDROID {
    VkStructureType sType;
    void * pNext;
    VkFormat format;
    uint64_t externalFormat;
    VkFormatFeatureFlags formatFeatures;
    VkComponentMapping samplerYcbcrConversionComponents;
    VkSamplerYcbcrModelConversion suggestedYcbcrModel;
    VkSamplerYcbcrRange suggestedYcbcrRange;
    VkChromaLocation suggestedXChromaOffset;
    VkChromaLocation suggestedYChromaOffset;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer An array of `VkAndroidHardwareBufferFormatPropertiesANDROID` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	EXTERNALFORMAT The struct member offsets.
public static final int	FORMAT The struct member offsets.
public static final int	FORMATFEATURES The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SAMPLERYCBCRCONVERSIONCOMPONENTS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.
public static final int	SUGGESTEDXCHROMAOFFSET The struct member offsets.
public static final int	SUGGESTEDYCBCRMODEL The struct member offsets.
public static final int	SUGGESTEDYCBCRRANGE The struct member offsets.
public static final int	SUGGESTEDYCHROMAOFFSET The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkAndroidHardwareBufferFormatPropertiesANDROID(long address, ByteBuffer container)
public	VkAndroidHardwareBufferFormatPropertiesANDROID(ByteBuffer container) Creates a `VkAndroidHardwareBufferFormatPropertiesANDROID` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkAndroidHardwareBufferFormatPropertiesANDROID	calloc() Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated with `memCalloc`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated with `memCalloc`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkAndroidHardwareBufferFormatPropertiesANDROID	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 VkAndroidHardwareBufferFormatPropertiesANDROID	create() Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated with `BufferUtils`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID	create(long address) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance for the specified memory address.
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	create(int the buffer capacity capacity) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated with `BufferUtils`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance at the specified memory.
public static VkAndroidHardwareBufferFormatPropertiesANDROID	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	externalFormat() an implementation-defined external format identifier for use with `VkExternalFormatANDROID`.
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.
public int	formatFeatures() describes the capabilities of this external format when used with an image bound to memory imported from `buffer`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID	malloc() Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated with `memAlloc`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated with `memAlloc`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated on the specified `MemoryStack`.
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated on the specified `MemoryStack`.
public static long	nexternalFormat(long struct) Unsafe version of `externalFormat`.
public static int	nformat(long struct) Unsafe version of `format`.
public static int	nformatFeatures(long struct) Unsafe version of `formatFeatures`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static VkComponentMapping	nsamplerYcbcrConversionComponents(long struct) Unsafe version of `samplerYcbcrConversionComponents`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public static int	nsuggestedXChromaOffset(long struct) Unsafe version of `suggestedXChromaOffset`.
public static int	nsuggestedYcbcrModel(long struct) Unsafe version of `suggestedYcbcrModel`.
public static int	nsuggestedYcbcrRange(long struct) Unsafe version of `suggestedYcbcrRange`.
public static int	nsuggestedYChromaOffset(long struct) Unsafe version of `suggestedYChromaOffset`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkAndroidHardwareBufferFormatPropertiesANDROID	pNext(long value) Sets the specified value to the `pNext` field.
public VkComponentMapping	samplerYcbcrConversionComponents() the component swizzle that should be used in `VkSamplerYcbcrConversionCreateInfo`.
public VkAndroidHardwareBufferFormatPropertiesANDROID	set(int sType, long pNext) Initializes this struct with the specified values.
public VkAndroidHardwareBufferFormatPropertiesANDROID	Returns: this struct set(VkAndroidHardwareBufferFormatPropertiesANDROID 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 VkAndroidHardwareBufferFormatPropertiesANDROID	sType(int value) Sets the specified value to the `sType` field.
public VkAndroidHardwareBufferFormatPropertiesANDROID	sType$Default() Sets the `STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID` value to the `sType` field.
public int	suggestedXChromaOffset() a suggested X chroma offset to use in `VkSamplerYcbcrConversionCreateInfo`.
public int	suggestedYcbcrModel() a suggested color model to use in the `VkSamplerYcbcrConversionCreateInfo`.
public int	suggestedYcbcrRange() a suggested numerical value range to use in `VkSamplerYcbcrConversionCreateInfo`.
public int	suggestedYChromaOffset() a suggested Y chroma offset to use in `VkSamplerYcbcrConversionCreateInfo`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

EXTERNALFORMAT	back to summary
public static final int EXTERNALFORMAT The struct member offsets.

FORMAT	back to summary
public static final int FORMAT The struct member offsets.

FORMATFEATURES	back to summary
public static final int FORMATFEATURES The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SAMPLERYCBCRCONVERSIONCOMPONENTS	back to summary
public static final int SAMPLERYCBCRCONVERSIONCOMPONENTS The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

SUGGESTEDXCHROMAOFFSET	back to summary
public static final int SUGGESTEDXCHROMAOFFSET The struct member offsets.

SUGGESTEDYCBCRMODEL	back to summary
public static final int SUGGESTEDYCBCRMODEL The struct member offsets.

SUGGESTEDYCBCRRANGE	back to summary
public static final int SUGGESTEDYCBCRRANGE The struct member offsets.

SUGGESTEDYCHROMAOFFSET	back to summary
public static final int SUGGESTEDYCHROMAOFFSET The struct member offsets.

Constructor Detail

VkAndroidHardwareBufferFormatPropertiesANDROID	back to summary
protected VkAndroidHardwareBufferFormatPropertiesANDROID(long address, ByteBuffer container)

VkAndroidHardwareBufferFormatPropertiesANDROID back to summary

VkAndroidHardwareBufferFormatPropertiesANDROID	back to summary
public VkAndroidHardwareBufferFormatPropertiesANDROID(ByteBuffer container) Creates a `VkAndroidHardwareBufferFormatPropertiesANDROID` 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.

public VkAndroidHardwareBufferFormatPropertiesANDROID(ByteBuffer container)

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

calloc	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID calloc() Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer calloc(int capacity) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID calloc(MemoryStack stack) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkAndroidHardwareBufferFormatPropertiesANDROID calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.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

public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer calloc(int capacity, MemoryStack stack)

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

create back to summary

create	back to summary
protected VkAndroidHardwareBufferFormatPropertiesANDROID 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

protected VkAndroidHardwareBufferFormatPropertiesANDROID 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

create	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID create() Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated with `BufferUtils`.

create	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID create(long address) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance for the specified memory address.

create back to summary

create	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer create(int capacity) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer create(int capacity)

Returns a new VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer create(long address, int capacity) Create a `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkAndroidHardwareBufferFormatPropertiesANDROID createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

externalFormat back to summary

externalFormat	back to summary
public long externalFormat() an implementation-defined external format identifier for use with `VkExternalFormatANDROID`. It must not be zero. Annotations @NativeType:uint64_t

public long externalFormat()

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

Annotations

@NativeType:uint64_t

format back to summary

format	back to summary
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. Annotations @NativeType:VkFormat

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.

Annotations

@NativeType:VkFormat

formatFeatures back to summary

formatFeatures	back to summary
public int formatFeatures() describes the capabilities of this external format when used with an image bound to memory imported from `buffer`. Annotations @NativeType:VkFormatFeatureFlags

public int formatFeatures()

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

Annotations

@NativeType:VkFormatFeatureFlags

malloc	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID malloc() Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer malloc(int capacity) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID malloc(MemoryStack stack) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkAndroidHardwareBufferFormatPropertiesANDROID malloc(MemoryStack stack)

Returns a new VkAndroidHardwareBufferFormatPropertiesANDROID instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

nexternalFormat	back to summary
public static long nexternalFormat(long struct) Unsafe version of `externalFormat`.

nformat	back to summary
public static int nformat(long struct) Unsafe version of `format`.

nformatFeatures	back to summary
public static int nformatFeatures(long struct) Unsafe version of `formatFeatures`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nsamplerYcbcrConversionComponents	back to summary
public static VkComponentMapping nsamplerYcbcrConversionComponents(long struct) Unsafe version of `samplerYcbcrConversionComponents`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

nsuggestedXChromaOffset	back to summary
public static int nsuggestedXChromaOffset(long struct) Unsafe version of `suggestedXChromaOffset`.

nsuggestedYcbcrModel	back to summary
public static int nsuggestedYcbcrModel(long struct) Unsafe version of `suggestedYcbcrModel`.

nsuggestedYcbcrRange	back to summary
public static int nsuggestedYcbcrRange(long struct) Unsafe version of `suggestedYcbcrRange`.

nsuggestedYChromaOffset	back to summary
public static int nsuggestedYChromaOffset(long struct) Unsafe version of `suggestedYChromaOffset`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void *

pNext	back to summary
public VkAndroidHardwareBufferFormatPropertiesANDROID pNext(long value) Sets the specified value to the `pNext` field.

samplerYcbcrConversionComponents	back to summary
public VkComponentMapping samplerYcbcrConversionComponents() the component swizzle that should be used in `VkSamplerYcbcrConversionCreateInfo`.

set	back to summary
public VkAndroidHardwareBufferFormatPropertiesANDROID set(int sType, long pNext) Initializes this struct with the specified values.

set

back to summary

public VkAndroidHardwareBufferFormatPropertiesANDROID set(VkAndroidHardwareBufferFormatPropertiesANDROID src)

Copies the specified struct data to this struct.

Parameters

src:VkAndroidHardwareBufferFormatPropertiesANDROID: the source struct

Returns:VkAndroidHardwareBufferFormatPropertiesANDROID

this struct

sizeof back to summary

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkAndroidHardwareBufferFormatPropertiesANDROID sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkAndroidHardwareBufferFormatPropertiesANDROID sType$Default() Sets the `STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID` value to the `sType` field.

suggestedXChromaOffset back to summary

public int suggestedXChromaOffset()

a suggested X chroma offset to use in VkSamplerYcbcrConversionCreateInfo.

Annotations

@NativeType:VkChromaLocation

suggestedYcbcrModel back to summary

public int suggestedYcbcrModel()

a suggested color model to use in the VkSamplerYcbcrConversionCreateInfo.

Annotations

@NativeType:VkSamplerYcbcrModelConversion

suggestedYcbcrRange back to summary

public int suggestedYcbcrRange()

a suggested numerical value range to use in VkSamplerYcbcrConversionCreateInfo.

Annotations

@NativeType:VkSamplerYcbcrRange

suggestedYChromaOffset back to summary

public int suggestedYChromaOffset()

a suggested Y chroma offset to use in VkSamplerYcbcrConversionCreateInfo.

Annotations

@NativeType:VkChromaLocation

org.lwjgl.vulkan back to summary

public Class VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer

Class Inheritance

extends StructBuffer<VkAndroidHardwareBufferFormatPropertiesANDROID, VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkAndroidHardwareBufferFormatPropertiesANDROID structs.

Field Summary

Modifier and Type	Field and Description
private static final VkAndroidHardwareBufferFormatPropertiesANDROID	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkAndroidHardwareBufferFormatPropertiesANDROID.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 Type	Method and Description
public long	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#externalFormat` field. externalFormat()
public int	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#format` field. format()
public int	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#formatFeatures` field. formatFeatures()
protected VkAndroidHardwareBufferFormatPropertiesANDROID	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#pNext` field. pNext()
public VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	pNext(long value) Sets the specified value to the `VkAndroidHardwareBufferFormatPropertiesANDROID#pNext` field.
public VkComponentMapping	Returns: a `VkComponentMapping` view of the `VkAndroidHardwareBufferFormatPropertiesANDROID#samplerYcbcrConversionComponents` field. samplerYcbcrConversionComponents()
protected VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#sType` field. sType()
public VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	sType(int value) Sets the specified value to the `VkAndroidHardwareBufferFormatPropertiesANDROID#sType` field.
public VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID` value to the `VkAndroidHardwareBufferFormatPropertiesANDROID#sType` field.
public int	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#suggestedXChromaOffset` field. suggestedXChromaOffset()
public int	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#suggestedYcbcrModel` field. suggestedYcbcrModel()
public int	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#suggestedYcbcrRange` field. suggestedYcbcrRange()
public int	Returns: the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#suggestedYChromaOffset` field. suggestedYChromaOffset()

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkAndroidHardwareBufferFormatPropertiesANDROID ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkAndroidHardwareBufferFormatPropertiesANDROID.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 VkAndroidHardwareBufferFormatPropertiesANDROID#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

externalFormat	back to summary
public long externalFormat() Returns:long the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#externalFormat` field. Annotations @NativeType:uint64_t

format	back to summary
public int format() Returns:int the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#format` field. Annotations @NativeType:VkFormat

formatFeatures	back to summary
public int formatFeatures() Returns:int the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#formatFeatures` field. Annotations @NativeType:VkFormatFeatureFlags

getElementFactory

back to summary

protected VkAndroidHardwareBufferFormatPropertiesANDROID getElementFactory()

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

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#pNext` field. Annotations @NativeType:void *

pNext	back to summary
public VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer pNext(long value) Sets the specified value to the `VkAndroidHardwareBufferFormatPropertiesANDROID#pNext` field.

samplerYcbcrConversionComponents	back to summary
public VkComponentMapping samplerYcbcrConversionComponents() Returns:VkComponentMapping a `VkComponentMapping` view of the `VkAndroidHardwareBufferFormatPropertiesANDROID#samplerYcbcrConversionComponents` field.

self

back to summary

protected VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer self()

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

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer sType(int value) Sets the specified value to the `VkAndroidHardwareBufferFormatPropertiesANDROID#sType` field.

sType$Default	back to summary
public VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer sType$Default() Sets the `STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID` value to the `VkAndroidHardwareBufferFormatPropertiesANDROID#sType` field.

suggestedXChromaOffset	back to summary
public int suggestedXChromaOffset() Returns:int the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#suggestedXChromaOffset` field. Annotations @NativeType:VkChromaLocation

suggestedYcbcrModel	back to summary
public int suggestedYcbcrModel() Returns:int the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#suggestedYcbcrModel` field. Annotations @NativeType:VkSamplerYcbcrModelConversion

suggestedYcbcrRange	back to summary
public int suggestedYcbcrRange() Returns:int the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#suggestedYcbcrRange` field. Annotations @NativeType:VkSamplerYcbcrRange

suggestedYChromaOffset	back to summary
public int suggestedYChromaOffset() Returns:int the value of the `VkAndroidHardwareBufferFormatPropertiesANDROID#suggestedYChromaOffset` field. Annotations @NativeType:VkChromaLocation

public Class VkAndroidHardwareBufferFormatPropertiesANDROID

Description

Note

Note

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkAndroidHardwareBufferFormatPropertiesANDROID.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail