Package org.lwjgl.vulkan

Class VkImportAndroidHardwareBufferInfoANDROID

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImportAndroidHardwareBufferInfoANDROID>

org.lwjgl.vulkan.VkImportAndroidHardwareBufferInfoANDROID

All Implemented Interfaces:

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

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

Import memory from an Android hardware buffer.

Description

If the AllocateMemory command succeeds, the implementation must acquire a reference to the imported hardware buffer, which it must release when the device memory object is freed. If the command fails, the implementation must not retain a reference.

Valid Usage

• If buffer is not NULL, Android hardware buffers must be supported for import, as reported by VkExternalImageFormatProperties or VkExternalBufferProperties
• If buffer is not NULL, it must be a valid Android hardware buffer object with AHardwareBuffer_Desc::usage compatible with Vulkan as described in Android Hardware Buffers

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• buffer must be a valid pointer to an AHardwareBuffer value

Layout

 struct VkImportAndroidHardwareBufferInfoANDROID {
     VkStructureType sType();
     void const * pNext();
     AHardwareBuffer * buffer();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
long	buffer()	the Android hardware buffer to import.
VkImportAndroidHardwareBufferInfoANDROID	buffer(long value)	Sets the specified value to the buffer() field.
static VkImportAndroidHardwareBufferInfoANDROID	calloc()	Returns a new VkImportAndroidHardwareBufferInfoANDROID instance allocated with memCalloc.
static VkImportAndroidHardwareBufferInfoANDROID.Buffer	calloc(int capacity)	Returns a new VkImportAndroidHardwareBufferInfoANDROID.Buffer instance allocated with memCalloc.
static VkImportAndroidHardwareBufferInfoANDROID.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImportAndroidHardwareBufferInfoANDROID.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImportAndroidHardwareBufferInfoANDROID	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImportAndroidHardwareBufferInfoANDROID instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImportAndroidHardwareBufferInfoANDROID	create()	Returns a new VkImportAndroidHardwareBufferInfoANDROID instance allocated with BufferUtils.
static VkImportAndroidHardwareBufferInfoANDROID.Buffer	create(int capacity)	Returns a new VkImportAndroidHardwareBufferInfoANDROID.Buffer instance allocated with BufferUtils.
static VkImportAndroidHardwareBufferInfoANDROID	create(long address)	Returns a new VkImportAndroidHardwareBufferInfoANDROID instance for the specified memory address.
static VkImportAndroidHardwareBufferInfoANDROID.Buffer	create(long address, int capacity)	Create a VkImportAndroidHardwareBufferInfoANDROID.Buffer instance at the specified memory.
static @Nullable VkImportAndroidHardwareBufferInfoANDROID	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImportAndroidHardwareBufferInfoANDROID.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkImportAndroidHardwareBufferInfoANDROID	malloc()	Returns a new VkImportAndroidHardwareBufferInfoANDROID instance allocated with memAlloc.
static VkImportAndroidHardwareBufferInfoANDROID.Buffer	malloc(int capacity)	Returns a new VkImportAndroidHardwareBufferInfoANDROID.Buffer instance allocated with memAlloc.
static VkImportAndroidHardwareBufferInfoANDROID.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImportAndroidHardwareBufferInfoANDROID.Buffer instance allocated on the specified MemoryStack.
static VkImportAndroidHardwareBufferInfoANDROID	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImportAndroidHardwareBufferInfoANDROID instance allocated on the specified MemoryStack.
static long	nbuffer(long struct)	Unsafe version of buffer().
static void	nbuffer(long struct, long value)	Unsafe version of buffer.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImportAndroidHardwareBufferInfoANDROID	pNext(long value)	Sets the specified value to the pNext() field.
VkImportAndroidHardwareBufferInfoANDROID	set(int sType, long pNext, long buffer)	Initializes this struct with the specified values.
VkImportAndroidHardwareBufferInfoANDROID	set(VkImportAndroidHardwareBufferInfoANDROID src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImportAndroidHardwareBufferInfoANDROID	sType(int value)	Sets the specified value to the sType() field.
VkImportAndroidHardwareBufferInfoANDROID	sType$Default()	Sets the STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

BUFFER

public static final int BUFFER

The struct member offsets.

Constructor Details

VkImportAndroidHardwareBufferInfoANDROID

public VkImportAndroidHardwareBufferInfoANDROID(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

buffer

public long buffer()

the Android hardware buffer to import.

sType

public VkImportAndroidHardwareBufferInfoANDROID sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImportAndroidHardwareBufferInfoANDROID sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_ANDROID_HARDWARE_BUFFER_INFO_ANDROID value to the sType() field.

pNext

public VkImportAndroidHardwareBufferInfoANDROID pNext(long value)

Sets the specified value to the pNext() field.

buffer

public VkImportAndroidHardwareBufferInfoANDROID buffer(long value)

Sets the specified value to the buffer() field.

set

public VkImportAndroidHardwareBufferInfoANDROID set(int sType,
 long pNext,
 long buffer)

Initializes this struct with the specified values.

set

public VkImportAndroidHardwareBufferInfoANDROID set(VkImportAndroidHardwareBufferInfoANDROID src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImportAndroidHardwareBufferInfoANDROID malloc()

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

calloc

public static VkImportAndroidHardwareBufferInfoANDROID calloc()

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

create

public static VkImportAndroidHardwareBufferInfoANDROID create()

Returns a new VkImportAndroidHardwareBufferInfoANDROID instance allocated with BufferUtils.

create

public static VkImportAndroidHardwareBufferInfoANDROID create(long address)

Returns a new VkImportAndroidHardwareBufferInfoANDROID instance for the specified memory address.

createSafe

public static @Nullable VkImportAndroidHardwareBufferInfoANDROID createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImportAndroidHardwareBufferInfoANDROID.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImportAndroidHardwareBufferInfoANDROID.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImportAndroidHardwareBufferInfoANDROID.Buffer create(int capacity)

Returns a new VkImportAndroidHardwareBufferInfoANDROID.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImportAndroidHardwareBufferInfoANDROID.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkImportAndroidHardwareBufferInfoANDROID instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nbuffer

public static long nbuffer(long struct)

Unsafe version of buffer().

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.

nbuffer

public static void nbuffer(long struct,
 long value)

Unsafe version of buffer.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate