Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAndroidHardwareBufferUsageANDROID

extends Struct<VkAndroidHardwareBufferUsageANDROID>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Struct containing Android hardware buffer usage flags.
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)

Layout


struct VkAndroidHardwareBufferUsageANDROID {
    VkStructureType sType;
    void * pNext;
    uint64_t androidHardwareBufferUsage;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkAndroidHardwareBufferUsageANDROID.Buffer

An array of VkAndroidHardwareBufferUsageANDROID structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ANDROIDHARDWAREBUFFERUSAGE

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
VkAndroidHardwareBufferUsageANDROID(long address, ByteBuffer container)

public
VkAndroidHardwareBufferUsageANDROID(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
androidHardwareBufferUsage()

returns the Android hardware buffer usage flags.

public static VkAndroidHardwareBufferUsageANDROID
calloc()

Returns a new VkAndroidHardwareBufferUsageANDROID instance allocated with memCalloc.

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

Returns a new VkAndroidHardwareBufferUsageANDROID.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkAndroidHardwareBufferUsageANDROID instance allocated with BufferUtils.

public static VkAndroidHardwareBufferUsageANDROID
create(long address)

Returns a new VkAndroidHardwareBufferUsageANDROID instance for the specified memory address.

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

Returns a new VkAndroidHardwareBufferUsageANDROID.Buffer instance allocated with BufferUtils.

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

Create a VkAndroidHardwareBufferUsageANDROID.Buffer instance at the specified memory.

public static VkAndroidHardwareBufferUsageANDROID
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkAndroidHardwareBufferUsageANDROID
malloc()

Returns a new VkAndroidHardwareBufferUsageANDROID instance allocated with memAlloc.

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

Returns a new VkAndroidHardwareBufferUsageANDROID.Buffer instance allocated with memAlloc.

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

Returns a new VkAndroidHardwareBufferUsageANDROID instance allocated on the specified MemoryStack.

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

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

public static long
nandroidHardwareBufferUsage(long struct)

Unsafe version of androidHardwareBufferUsage.

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

Sets the specified value to the pNext field.

public VkAndroidHardwareBufferUsageANDROID
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkAndroidHardwareBufferUsageANDROID

Returns:

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

Sets the specified value to the sType field.

public VkAndroidHardwareBufferUsageANDROID
sType$Default()

Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID 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.

ANDROIDHARDWAREBUFFERUSAGEback to summary
public static final int ANDROIDHARDWAREBUFFERUSAGE

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

VkAndroidHardwareBufferUsageANDROIDback to summary
protected VkAndroidHardwareBufferUsageANDROID(long address, ByteBuffer container)
VkAndroidHardwareBufferUsageANDROIDback to summary
public VkAndroidHardwareBufferUsageANDROID(ByteBuffer container)

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

androidHardwareBufferUsageback to summary
public long androidHardwareBufferUsage()

returns the Android hardware buffer usage flags.

Annotations
@NativeType:uint64_t
callocback to summary
public static VkAndroidHardwareBufferUsageANDROID calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAndroidHardwareBufferUsageANDROID calloc(MemoryStack stack)

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

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

Returns a new VkAndroidHardwareBufferUsageANDROID instance allocated with BufferUtils.

createback to summary
public static VkAndroidHardwareBufferUsageANDROID create(long address)

Returns a new VkAndroidHardwareBufferUsageANDROID instance for the specified memory address.

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

Returns a new VkAndroidHardwareBufferUsageANDROID.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAndroidHardwareBufferUsageANDROID.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAndroidHardwareBufferUsageANDROID createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkAndroidHardwareBufferUsageANDROID malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAndroidHardwareBufferUsageANDROID malloc(MemoryStack stack)

Returns a new VkAndroidHardwareBufferUsageANDROID instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nandroidHardwareBufferUsageback to summary
public static long nandroidHardwareBufferUsage(long struct)

Unsafe version of androidHardwareBufferUsage.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkAndroidHardwareBufferUsageANDROID set(VkAndroidHardwareBufferUsageANDROID src)

Copies the specified struct data to this struct.

Parameters
src:VkAndroidHardwareBufferUsageANDROID

the source struct

Returns:VkAndroidHardwareBufferUsageANDROID

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkAndroidHardwareBufferUsageANDROID.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkAndroidHardwareBufferUsageANDROID
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkAndroidHardwareBufferUsageANDROID.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 long

Returns:

the value of the VkAndroidHardwareBufferUsageANDROID#androidHardwareBufferUsage field.
androidHardwareBufferUsage()

protected VkAndroidHardwareBufferUsageANDROID
getElementFactory()

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

public long

Returns:

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

public VkAndroidHardwareBufferUsageANDROID.Buffer
pNext(long value)

Sets the specified value to the VkAndroidHardwareBufferUsageANDROID#pNext field.

protected VkAndroidHardwareBufferUsageANDROID.Buffer
self()

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

public int

Returns:

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

public VkAndroidHardwareBufferUsageANDROID.Buffer
sType(int value)

Sets the specified value to the VkAndroidHardwareBufferUsageANDROID#sType field.

public VkAndroidHardwareBufferUsageANDROID.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID value to the VkAndroidHardwareBufferUsageANDROID#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAndroidHardwareBufferUsageANDROID ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

androidHardwareBufferUsageback to summary
public long androidHardwareBufferUsage()
Returns:long

the value of the VkAndroidHardwareBufferUsageANDROID#androidHardwareBufferUsage field.

Annotations
@NativeType:uint64_t
getElementFactoryback to summary
protected VkAndroidHardwareBufferUsageANDROID getElementFactory()

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

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

the value of the VkAndroidHardwareBufferUsageANDROID#pNext field.

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

Sets the specified value to the VkAndroidHardwareBufferUsageANDROID#pNext field.

selfback to summary
protected VkAndroidHardwareBufferUsageANDROID.Buffer self()

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

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

the value of the VkAndroidHardwareBufferUsageANDROID#sType field.

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

Sets the specified value to the VkAndroidHardwareBufferUsageANDROID#sType field.

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

Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_USAGE_ANDROID value to the VkAndroidHardwareBufferUsageANDROID#sType field.