Class VkAndroidHardwareBufferUsageANDROID
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
The androidHardwareBufferUsage field must include Android hardware buffer usage flags listed in the AHardwareBuffer Usage Equivalence table when the corresponding Vulkan image usage or image creation flags are included in the usage or flags fields of VkPhysicalDeviceImageFormatInfo2. It must include at least one GPU usage flag (AHARDWAREBUFFER_USAGE_GPU_*), even if none of the corresponding Vulkan usages or flags are requested.
Note
Requiring at least one GPU usage flag ensures that Android hardware buffer memory will be allocated in a memory pool accessible to the Vulkan implementation, and that specializing the memory layout based on usage flags does not prevent it from being compatible with Vulkan. Implementations may avoid unnecessary restrictions caused by this requirement by using vendor usage flags to indicate that only the Vulkan uses indicated in VkImageFormatProperties2 are required.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID
Layout
struct VkAndroidHardwareBufferUsageANDROID {
VkStructureType sType();
void * pNext();
uint64_t androidHardwareBufferUsage();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkAndroidHardwareBufferUsageANDROIDstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkAndroidHardwareBufferUsageANDROID(ByteBuffer container) Creates aVkAndroidHardwareBufferUsageANDROIDinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionlongreturns the Android hardware buffer usage flags.calloc()Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated withBufferUtils.create(int capacity) Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkAndroidHardwareBufferUsageANDROIDinstance for the specified memory address.create(long address, int capacity) Create aVkAndroidHardwareBufferUsageANDROID.Bufferinstance at the specified memory.static @Nullable VkAndroidHardwareBufferUsageANDROIDcreateSafe(long address) static @Nullable VkAndroidHardwareBufferUsageANDROID.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated on the specifiedMemoryStack.static longnandroidHardwareBufferUsage(long struct) Unsafe version ofandroidHardwareBufferUsage().static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROIDvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
ANDROIDHARDWAREBUFFERUSAGE
public static final int ANDROIDHARDWAREBUFFERUSAGEThe struct member offsets.
-
-
Constructor Details
-
VkAndroidHardwareBufferUsageANDROID
Creates aVkAndroidHardwareBufferUsageANDROIDinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkAndroidHardwareBufferUsageANDROID>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
androidHardwareBufferUsage
public long androidHardwareBufferUsage()returns the Android hardware buffer usage flags. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROIDvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated withBufferUtils. -
create
Returns a newVkAndroidHardwareBufferUsageANDROIDinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkAndroidHardwareBufferUsageANDROID.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkAndroidHardwareBufferUsageANDROID.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkAndroidHardwareBufferUsageANDROIDinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkAndroidHardwareBufferUsageANDROID.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkAndroidHardwareBufferUsageANDROID.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkAndroidHardwareBufferUsageANDROID.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nandroidHardwareBufferUsage
public static long nandroidHardwareBufferUsage(long struct) Unsafe version ofandroidHardwareBufferUsage(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext.
-