Package org.lwjgl.vulkan

Class VkAndroidHardwareBufferPropertiesANDROID

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAndroidHardwareBufferPropertiesANDROID>

org.lwjgl.vulkan.VkAndroidHardwareBufferPropertiesANDROID

All Implemented Interfaces:

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

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

Properties of External Memory Android Hardware Buffers.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkAndroidHardwareBufferFormatProperties2ANDROID, VkAndroidHardwareBufferFormatPropertiesANDROID, or VkAndroidHardwareBufferFormatResolvePropertiesANDROID
• The sType value of each struct in the pNext chain must be unique

See Also

GetAndroidHardwareBufferPropertiesANDROID

Layout

 struct VkAndroidHardwareBufferPropertiesANDROID {
     VkStructureType sType();
     void * pNext();
     VkDeviceSize allocationSize();
     uint32_t memoryTypeBits();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAndroidHardwareBufferPropertiesANDROID.Buffer	An array of VkAndroidHardwareBufferPropertiesANDROID 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	ALLOCATIONSIZE	The struct member offsets.
static final int	MEMORYTYPEBITS	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
VkAndroidHardwareBufferPropertiesANDROID(ByteBuffer container)	Creates a VkAndroidHardwareBufferPropertiesANDROID instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	allocationSize()	the size of the external memory
static VkAndroidHardwareBufferPropertiesANDROID	calloc()	Returns a new VkAndroidHardwareBufferPropertiesANDROID instance allocated with memCalloc.
static VkAndroidHardwareBufferPropertiesANDROID.Buffer	calloc(int capacity)	Returns a new VkAndroidHardwareBufferPropertiesANDROID.Buffer instance allocated with memCalloc.
static VkAndroidHardwareBufferPropertiesANDROID.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferPropertiesANDROID.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAndroidHardwareBufferPropertiesANDROID	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferPropertiesANDROID instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAndroidHardwareBufferPropertiesANDROID	create()	Returns a new VkAndroidHardwareBufferPropertiesANDROID instance allocated with BufferUtils.
static VkAndroidHardwareBufferPropertiesANDROID.Buffer	create(int capacity)	Returns a new VkAndroidHardwareBufferPropertiesANDROID.Buffer instance allocated with BufferUtils.
static VkAndroidHardwareBufferPropertiesANDROID	create(long address)	Returns a new VkAndroidHardwareBufferPropertiesANDROID instance for the specified memory address.
static VkAndroidHardwareBufferPropertiesANDROID.Buffer	create(long address, int capacity)	Create a VkAndroidHardwareBufferPropertiesANDROID.Buffer instance at the specified memory.
static @Nullable VkAndroidHardwareBufferPropertiesANDROID	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAndroidHardwareBufferPropertiesANDROID.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAndroidHardwareBufferPropertiesANDROID	malloc()	Returns a new VkAndroidHardwareBufferPropertiesANDROID instance allocated with memAlloc.
static VkAndroidHardwareBufferPropertiesANDROID.Buffer	malloc(int capacity)	Returns a new VkAndroidHardwareBufferPropertiesANDROID.Buffer instance allocated with memAlloc.
static VkAndroidHardwareBufferPropertiesANDROID.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferPropertiesANDROID.Buffer instance allocated on the specified MemoryStack.
static VkAndroidHardwareBufferPropertiesANDROID	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferPropertiesANDROID instance allocated on the specified MemoryStack.
int	memoryTypeBits()	a bitmask containing one bit set for every memory type which the specified Android hardware buffer can be imported as.
static long	nallocationSize(long struct)	Unsafe version of allocationSize().
static int	nmemoryTypeBits(long struct)	Unsafe version of memoryTypeBits().
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.
VkAndroidHardwareBufferPropertiesANDROID	pNext(long value)	Sets the specified value to the pNext() field.
VkAndroidHardwareBufferPropertiesANDROID	pNext(VkAndroidHardwareBufferFormatProperties2ANDROID value)	Prepends the specified VkAndroidHardwareBufferFormatProperties2ANDROID value to the pNext chain.
VkAndroidHardwareBufferPropertiesANDROID	pNext(VkAndroidHardwareBufferFormatPropertiesANDROID value)	Prepends the specified VkAndroidHardwareBufferFormatPropertiesANDROID value to the pNext chain.
VkAndroidHardwareBufferPropertiesANDROID	pNext(VkAndroidHardwareBufferFormatResolvePropertiesANDROID value)	Prepends the specified VkAndroidHardwareBufferFormatResolvePropertiesANDROID value to the pNext chain.
VkAndroidHardwareBufferPropertiesANDROID	set(int sType, long pNext)	Initializes this struct with the specified values.
VkAndroidHardwareBufferPropertiesANDROID	set(VkAndroidHardwareBufferPropertiesANDROID src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAndroidHardwareBufferPropertiesANDROID	sType(int value)	Sets the specified value to the sType() field.
VkAndroidHardwareBufferPropertiesANDROID	sType$Default()	Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_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.

ALLOCATIONSIZE

public static final int ALLOCATIONSIZE

The struct member offsets.

MEMORYTYPEBITS

public static final int MEMORYTYPEBITS

The struct member offsets.

Constructor Details

VkAndroidHardwareBufferPropertiesANDROID

public VkAndroidHardwareBufferPropertiesANDROID(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

allocationSize

public long allocationSize()

the size of the external memory

memoryTypeBits

public int memoryTypeBits()

a bitmask containing one bit set for every memory type which the specified Android hardware buffer can be imported as.

sType

public VkAndroidHardwareBufferPropertiesANDROID sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAndroidHardwareBufferPropertiesANDROID sType$Default()

Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_PROPERTIES_ANDROID value to the sType() field.

pNext

public VkAndroidHardwareBufferPropertiesANDROID pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkAndroidHardwareBufferPropertiesANDROID pNext(VkAndroidHardwareBufferFormatProperties2ANDROID value)

Prepends the specified VkAndroidHardwareBufferFormatProperties2ANDROID value to the pNext chain.

pNext

public VkAndroidHardwareBufferPropertiesANDROID pNext(VkAndroidHardwareBufferFormatPropertiesANDROID value)

Prepends the specified VkAndroidHardwareBufferFormatPropertiesANDROID value to the pNext chain.

pNext

public VkAndroidHardwareBufferPropertiesANDROID pNext(VkAndroidHardwareBufferFormatResolvePropertiesANDROID value)

Prepends the specified VkAndroidHardwareBufferFormatResolvePropertiesANDROID value to the pNext chain.

set

public VkAndroidHardwareBufferPropertiesANDROID set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkAndroidHardwareBufferPropertiesANDROID set(VkAndroidHardwareBufferPropertiesANDROID src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAndroidHardwareBufferPropertiesANDROID malloc()

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

calloc

public static VkAndroidHardwareBufferPropertiesANDROID calloc()

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

create

public static VkAndroidHardwareBufferPropertiesANDROID create()

Returns a new VkAndroidHardwareBufferPropertiesANDROID instance allocated with BufferUtils.

create

public static VkAndroidHardwareBufferPropertiesANDROID create(long address)

Returns a new VkAndroidHardwareBufferPropertiesANDROID instance for the specified memory address.

createSafe

public static @Nullable VkAndroidHardwareBufferPropertiesANDROID createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAndroidHardwareBufferPropertiesANDROID.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAndroidHardwareBufferPropertiesANDROID.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAndroidHardwareBufferPropertiesANDROID.Buffer create(int capacity)

Returns a new VkAndroidHardwareBufferPropertiesANDROID.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAndroidHardwareBufferPropertiesANDROID.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAndroidHardwareBufferPropertiesANDROID instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nallocationSize

public static long nallocationSize(long struct)

Unsafe version of allocationSize().

nmemoryTypeBits

public static int nmemoryTypeBits(long struct)

Unsafe version of memoryTypeBits().

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.