Package org.lwjgl.vulkan

Class VkExternalMemoryProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkExternalMemoryProperties

All Implemented Interfaces:

org.lwjgl.system.Pointer

Direct Known Subclasses:

VkExternalMemoryPropertiesKHR

public class VkExternalMemoryProperties
extends org.lwjgl.system.Struct

Structure specifying external memory handle type capabilities.

Description

compatibleHandleTypes must include at least handleType. Inclusion of a handle type in compatibleHandleTypes does not imply the values returned in VkImageFormatProperties2 will be the same when VkPhysicalDeviceExternalImageFormatInfo::handleType is set to that type. The application is responsible for querying the capabilities of all handle types intended for concurrent use in a single image and intersecting them to obtain the compatible set of capabilities.

See Also

VkExternalBufferProperties, VkExternalImageFormatProperties

Layout

 struct VkExternalMemoryProperties {
     VkExternalMemoryFeatureFlags externalMemoryFeatures();
     VkExternalMemoryHandleTypeFlags exportFromImportedHandleTypes();
     VkExternalMemoryHandleTypeFlags compatibleHandleTypes();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkExternalMemoryProperties.Buffer	An array of VkExternalMemoryProperties structs.

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	COMPATIBLEHANDLETYPES EXPORTFROMIMPORTEDHANDLETYPES EXTERNALMEMORYFEATURES	The struct member offsets.
static int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkExternalMemoryProperties(java.nio.ByteBuffer container)	Creates a VkExternalMemoryProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	compatibleHandleTypes()	a bitmask of VkExternalMemoryHandleTypeFlagBits specifying handle types which can be specified at the same time as handleType when creating an image compatible with external memory.
static VkExternalMemoryProperties	create(long address)	Returns a new VkExternalMemoryProperties instance for the specified memory address.
static VkExternalMemoryProperties.Buffer	create(long address, int capacity)	Create a VkExternalMemoryProperties.Buffer instance at the specified memory.
static VkExternalMemoryProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static VkExternalMemoryProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	exportFromImportedHandleTypes()	a bitmask of VkExternalMemoryHandleTypeFlagBits specifying which types of imported handle handleType can be exported from.
int	externalMemoryFeatures()	a bitmask of VkExternalMemoryFeatureFlagBits specifying the features of handleType.
static int	ncompatibleHandleTypes(long struct)	Unsafe version of compatibleHandleTypes().
static int	nexportFromImportedHandleTypes(long struct)	Unsafe version of exportFromImportedHandleTypes().
static int	nexternalMemoryFeatures(long struct)	Unsafe version of externalMemoryFeatures().
int	sizeof()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

EXTERNALMEMORYFEATURES, EXPORTFROMIMPORTEDHANDLETYPES, COMPATIBLEHANDLETYPES

The struct member offsets.

Constructor Detail

VkExternalMemoryProperties

public VkExternalMemoryProperties(java.nio.ByteBuffer container)

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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct

externalMemoryFeatures

public int externalMemoryFeatures()

a bitmask of VkExternalMemoryFeatureFlagBits specifying the features of handleType.

exportFromImportedHandleTypes

public int exportFromImportedHandleTypes()

a bitmask of VkExternalMemoryHandleTypeFlagBits specifying which types of imported handle handleType can be exported from.

compatibleHandleTypes

public int compatibleHandleTypes()

a bitmask of VkExternalMemoryHandleTypeFlagBits specifying handle types which can be specified at the same time as handleType when creating an image compatible with external memory.

create

public static VkExternalMemoryProperties create(long address)

Returns a new VkExternalMemoryProperties instance for the specified memory address.

createSafe

@Nullable
public static VkExternalMemoryProperties createSafe(long address)

Like create, but returns null if address is NULL.

create

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

Create a VkExternalMemoryProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

nexternalMemoryFeatures

public static int nexternalMemoryFeatures(long struct)

Unsafe version of externalMemoryFeatures().

nexportFromImportedHandleTypes

public static int nexportFromImportedHandleTypes(long struct)

Unsafe version of exportFromImportedHandleTypes().

ncompatibleHandleTypes

public static int ncompatibleHandleTypes(long struct)

Unsafe version of compatibleHandleTypes().