Package org.lwjgl.vulkan

Class VkMemoryGetAndroidHardwareBufferInfoANDROID

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryGetAndroidHardwareBufferInfoANDROID>

org.lwjgl.vulkan.VkMemoryGetAndroidHardwareBufferInfoANDROID

All Implemented Interfaces:

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

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

Structure describing an Android hardware buffer memory export operation.

Valid Usage

• EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID must have been included in VkExportMemoryAllocateInfo::handleTypes when memory was created
• If the pNext chain of the VkMemoryAllocateInfo used to allocate memory included a VkMemoryDedicatedAllocateInfo with non-NULL image member, then that image must already be bound to memory

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID
• pNext must be NULL
• memory must be a valid VkDeviceMemory handle

See Also

GetMemoryAndroidHardwareBufferANDROID

Layout

 struct VkMemoryGetAndroidHardwareBufferInfoANDROID {
     VkStructureType sType();
     void const * pNext();
     VkDeviceMemory memory();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer	An array of VkMemoryGetAndroidHardwareBufferInfoANDROID 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	MEMORY	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
VkMemoryGetAndroidHardwareBufferInfoANDROID(ByteBuffer container)	Creates a VkMemoryGetAndroidHardwareBufferInfoANDROID instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkMemoryGetAndroidHardwareBufferInfoANDROID	calloc()	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance allocated with memCalloc.
static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer	calloc(int capacity)	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer instance allocated with memCalloc.
static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryGetAndroidHardwareBufferInfoANDROID	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryGetAndroidHardwareBufferInfoANDROID	create()	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance allocated with BufferUtils.
static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer	create(int capacity)	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer instance allocated with BufferUtils.
static VkMemoryGetAndroidHardwareBufferInfoANDROID	create(long address)	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance for the specified memory address.
static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer	create(long address, int capacity)	Create a VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer instance at the specified memory.
static @Nullable VkMemoryGetAndroidHardwareBufferInfoANDROID	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkMemoryGetAndroidHardwareBufferInfoANDROID	malloc()	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance allocated with memAlloc.
static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer	malloc(int capacity)	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer instance allocated with memAlloc.
static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer instance allocated on the specified MemoryStack.
static VkMemoryGetAndroidHardwareBufferInfoANDROID	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance allocated on the specified MemoryStack.
long	memory()	the memory object from which the Android hardware buffer will be exported.
VkMemoryGetAndroidHardwareBufferInfoANDROID	memory(long value)	Sets the specified value to the memory() field.
static long	nmemory(long struct)	Unsafe version of memory().
static void	nmemory(long struct, long value)	Unsafe version of memory.
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.
VkMemoryGetAndroidHardwareBufferInfoANDROID	pNext(long value)	Sets the specified value to the pNext() field.
VkMemoryGetAndroidHardwareBufferInfoANDROID	set(int sType, long pNext, long memory)	Initializes this struct with the specified values.
VkMemoryGetAndroidHardwareBufferInfoANDROID	set(VkMemoryGetAndroidHardwareBufferInfoANDROID src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkMemoryGetAndroidHardwareBufferInfoANDROID	sType(int value)	Sets the specified value to the sType() field.
VkMemoryGetAndroidHardwareBufferInfoANDROID	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID value to the sType() field.

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.

MEMORY

public static final int MEMORY

The struct member offsets.

Constructor Details

VkMemoryGetAndroidHardwareBufferInfoANDROID

public VkMemoryGetAndroidHardwareBufferInfoANDROID(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

memory

public long memory()

the memory object from which the Android hardware buffer will be exported.

sType

public VkMemoryGetAndroidHardwareBufferInfoANDROID sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMemoryGetAndroidHardwareBufferInfoANDROID sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_GET_ANDROID_HARDWARE_BUFFER_INFO_ANDROID value to the sType() field.

pNext

public VkMemoryGetAndroidHardwareBufferInfoANDROID pNext(long value)

Sets the specified value to the pNext() field.

memory

public VkMemoryGetAndroidHardwareBufferInfoANDROID memory(long value)

Sets the specified value to the memory() field.

set

public VkMemoryGetAndroidHardwareBufferInfoANDROID set(int sType,
 long pNext,
 long memory)

Initializes this struct with the specified values.

set

public VkMemoryGetAndroidHardwareBufferInfoANDROID set(VkMemoryGetAndroidHardwareBufferInfoANDROID src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryGetAndroidHardwareBufferInfoANDROID malloc()

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

calloc

public static VkMemoryGetAndroidHardwareBufferInfoANDROID calloc()

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

create

public static VkMemoryGetAndroidHardwareBufferInfoANDROID create()

Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance allocated with BufferUtils.

create

public static VkMemoryGetAndroidHardwareBufferInfoANDROID create(long address)

Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance for the specified memory address.

createSafe

public static @Nullable VkMemoryGetAndroidHardwareBufferInfoANDROID createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer create(int capacity)

Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMemoryGetAndroidHardwareBufferInfoANDROID.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkMemoryGetAndroidHardwareBufferInfoANDROID instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmemory

public static long nmemory(long struct)

Unsafe version of memory().

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.

nmemory

public static void nmemory(long struct,
 long value)

Unsafe version of memory.