Package org.lwjgl.vulkan

Class VkAndroidHardwareBufferFormatResolvePropertiesANDROID

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAndroidHardwareBufferFormatResolvePropertiesANDROID>

org.lwjgl.vulkan.VkAndroidHardwareBufferFormatResolvePropertiesANDROID

All Implemented Interfaces:

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

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

Structure defining properties of resolves using an external format.

Description

Any Android hardware buffer created with the GRALLOC_USAGE_HW_RENDER flag must be renderable in some way in Vulkan, either:

• VkAndroidHardwareBufferFormatPropertiesANDROID::format must be a format that supports FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT in VkFormatProperties::optimalTilingFeatures; or
• colorAttachmentFormat must be a format that supports FORMAT_FEATURE_COLOR_ATTACHMENT_BIT in VkFormatProperties::optimalTilingFeatures.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_RESOLVE_PROPERTIES_ANDROID

Layout

 struct VkAndroidHardwareBufferFormatResolvePropertiesANDROID {
     VkStructureType sType();
     void * pNext();
     VkFormat colorAttachmentFormat();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID	calloc()	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance allocated with memCalloc.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer	calloc(int capacity)	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer instance allocated with memCalloc.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	colorAttachmentFormat()	a VkFormat specifying the format of color attachment images that must be used for color attachments when resolving to the specified external format.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID	create()	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance allocated with BufferUtils.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer	create(int capacity)	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer instance allocated with BufferUtils.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID	create(long address)	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance for the specified memory address.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer	create(long address, int capacity)	Create a VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer instance at the specified memory.
static @Nullable VkAndroidHardwareBufferFormatResolvePropertiesANDROID	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID	malloc()	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance allocated with memAlloc.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer	malloc(int capacity)	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer instance allocated with memAlloc.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer instance allocated on the specified MemoryStack.
static VkAndroidHardwareBufferFormatResolvePropertiesANDROID	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance allocated on the specified MemoryStack.
static int	ncolorAttachmentFormat(long struct)	Unsafe version of colorAttachmentFormat().
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.
VkAndroidHardwareBufferFormatResolvePropertiesANDROID	pNext(long value)	Sets the specified value to the pNext() field.
VkAndroidHardwareBufferFormatResolvePropertiesANDROID	set(int sType, long pNext)	Initializes this struct with the specified values.
VkAndroidHardwareBufferFormatResolvePropertiesANDROID	set(VkAndroidHardwareBufferFormatResolvePropertiesANDROID src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAndroidHardwareBufferFormatResolvePropertiesANDROID	sType(int value)	Sets the specified value to the sType() field.
VkAndroidHardwareBufferFormatResolvePropertiesANDROID	sType$Default()	Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_RESOLVE_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.

COLORATTACHMENTFORMAT

public static final int COLORATTACHMENTFORMAT

The struct member offsets.

Constructor Details

VkAndroidHardwareBufferFormatResolvePropertiesANDROID

public VkAndroidHardwareBufferFormatResolvePropertiesANDROID(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

colorAttachmentFormat

public int colorAttachmentFormat()

a VkFormat specifying the format of color attachment images that must be used for color attachments when resolving to the specified external format. If the implementation supports external format resolves for the specified external format, this value will be a color format supporting the FORMAT_FEATURE_COLOR_ATTACHMENT_BIT in VkFormatProperties::optimalTilingFeatures as returned by GetPhysicalDeviceFormatProperties with format equal to colorAttachmentFormat If external format resolves are not supported, this value will be FORMAT_UNDEFINED.

sType

public VkAndroidHardwareBufferFormatResolvePropertiesANDROID sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAndroidHardwareBufferFormatResolvePropertiesANDROID sType$Default()

Sets the STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_RESOLVE_PROPERTIES_ANDROID value to the sType() field.

pNext

public VkAndroidHardwareBufferFormatResolvePropertiesANDROID pNext(long value)

Sets the specified value to the pNext() field.

set

public VkAndroidHardwareBufferFormatResolvePropertiesANDROID set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkAndroidHardwareBufferFormatResolvePropertiesANDROID set(VkAndroidHardwareBufferFormatResolvePropertiesANDROID src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAndroidHardwareBufferFormatResolvePropertiesANDROID malloc()

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

calloc

public static VkAndroidHardwareBufferFormatResolvePropertiesANDROID calloc()

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

create

public static VkAndroidHardwareBufferFormatResolvePropertiesANDROID create()

Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance allocated with BufferUtils.

create

public static VkAndroidHardwareBufferFormatResolvePropertiesANDROID create(long address)

Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance for the specified memory address.

createSafe

public static @Nullable VkAndroidHardwareBufferFormatResolvePropertiesANDROID createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer create(int capacity)

Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAndroidHardwareBufferFormatResolvePropertiesANDROID.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAndroidHardwareBufferFormatResolvePropertiesANDROID instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncolorAttachmentFormat

public static int ncolorAttachmentFormat(long struct)

Unsafe version of colorAttachmentFormat().

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.