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.

Layout


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

Nested and Inner Type Summary

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

Field Summary

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

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkExternalMemoryProperties(long address, ByteBuffer container)
public	VkExternalMemoryProperties(ByteBuffer container) Creates a `VkExternalMemoryProperties` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
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.
protected VkExternalMemoryProperties	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkExternalMemoryProperties	create(long address) Returns a new `VkExternalMemoryProperties` instance for the specified memory address.
public static VkExternalMemoryProperties.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkExternalMemoryProperties.Buffer` instance at the specified memory.
public static VkExternalMemoryProperties	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkExternalMemoryProperties.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	exportFromImportedHandleTypes() a bitmask of `VkExternalMemoryHandleTypeFlagBits` specifying which types of imported handle `handleType` can be exported from.
public int	externalMemoryFeatures() a bitmask of `VkExternalMemoryFeatureFlagBits` specifying the features of `handleType`.
public static int	ncompatibleHandleTypes(long struct) Unsafe version of `compatibleHandleTypes`.
public static int	nexportFromImportedHandleTypes(long struct) Unsafe version of `exportFromImportedHandleTypes`.
public static int	nexternalMemoryFeatures(long struct) Unsafe version of `externalMemoryFeatures`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

COMPATIBLEHANDLETYPES	back to summary
public static final int COMPATIBLEHANDLETYPES The struct member offsets.

EXPORTFROMIMPORTEDHANDLETYPES	back to summary
public static final int EXPORTFROMIMPORTEDHANDLETYPES The struct member offsets.

EXTERNALMEMORYFEATURES	back to summary
public static final int EXTERNALMEMORYFEATURES The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkExternalMemoryProperties	back to summary
protected VkExternalMemoryProperties(long address, ByteBuffer container)

VkExternalMemoryProperties back to summary

VkExternalMemoryProperties	back to summary
public VkExternalMemoryProperties(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.

public VkExternalMemoryProperties(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

compatibleHandleTypes back to summary

compatibleHandleTypes	back to summary
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. Annotations @NativeType:VkExternalMemoryHandleTypeFlags

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.

Annotations

@NativeType:VkExternalMemoryHandleTypeFlags

create back to summary

create	back to summary
protected VkExternalMemoryProperties create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkExternalMemoryProperties create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkExternalMemoryProperties create(long address) Returns a new `VkExternalMemoryProperties` instance for the specified memory address.

create back to summary

create	back to summary
public static VkExternalMemoryProperties.Buffer create(long address, int capacity) Create a `VkExternalMemoryProperties.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkExternalMemoryProperties.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkExternalMemoryProperties createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkExternalMemoryProperties createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkExternalMemoryProperties.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

exportFromImportedHandleTypes back to summary

exportFromImportedHandleTypes	back to summary
public int exportFromImportedHandleTypes() a bitmask of `VkExternalMemoryHandleTypeFlagBits` specifying which types of imported handle `handleType` can be exported from. Annotations @NativeType:VkExternalMemoryHandleTypeFlags

public int exportFromImportedHandleTypes()

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

Annotations

@NativeType:VkExternalMemoryHandleTypeFlags

externalMemoryFeatures back to summary

externalMemoryFeatures	back to summary
public int externalMemoryFeatures() a bitmask of `VkExternalMemoryFeatureFlagBits` specifying the features of `handleType`. Annotations @NativeType:VkExternalMemoryFeatureFlags

public int externalMemoryFeatures()

a bitmask of VkExternalMemoryFeatureFlagBits specifying the features of handleType.

Annotations

@NativeType:VkExternalMemoryFeatureFlags

ncompatibleHandleTypes	back to summary
public static int ncompatibleHandleTypes(long struct) Unsafe version of `compatibleHandleTypes`.

nexportFromImportedHandleTypes	back to summary
public static int nexportFromImportedHandleTypes(long struct) Unsafe version of `exportFromImportedHandleTypes`.

nexternalMemoryFeatures	back to summary
public static int nexternalMemoryFeatures(long struct) Unsafe version of `externalMemoryFeatures`.

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.vulkan back to summary

public Class VkExternalMemoryProperties.Buffer

Class Inheritance

extends StructBuffer<VkExternalMemoryProperties, VkExternalMemoryProperties.Buffer>

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkExternalMemoryProperties.Buffer

Known Direct Subclasses

org.lwjgl.vulkan.VkExternalMemoryPropertiesKHR.Buffer

An array of VkExternalMemoryProperties structs.

Field Summary

Modifier and Type	Field and Description
private static final VkExternalMemoryProperties	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkExternalMemoryProperties.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value of the `VkExternalMemoryProperties#compatibleHandleTypes` field. compatibleHandleTypes()
public int	Returns: the value of the `VkExternalMemoryProperties#exportFromImportedHandleTypes` field. exportFromImportedHandleTypes()
public int	Returns: the value of the `VkExternalMemoryProperties#externalMemoryFeatures` field. externalMemoryFeatures()
protected VkExternalMemoryProperties	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkExternalMemoryProperties.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkExternalMemoryProperties ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkExternalMemoryProperties.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `VkExternalMemoryProperties#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkExternalMemoryProperties.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkExternalMemoryProperties#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

compatibleHandleTypes	back to summary
public int compatibleHandleTypes() Returns:int the value of the `VkExternalMemoryProperties#compatibleHandleTypes` field. Annotations @NativeType:VkExternalMemoryHandleTypeFlags

exportFromImportedHandleTypes	back to summary
public int exportFromImportedHandleTypes() Returns:int the value of the `VkExternalMemoryProperties#exportFromImportedHandleTypes` field. Annotations @NativeType:VkExternalMemoryHandleTypeFlags

externalMemoryFeatures	back to summary
public int externalMemoryFeatures() Returns:int the value of the `VkExternalMemoryProperties#externalMemoryFeatures` field. Annotations @NativeType:VkExternalMemoryFeatureFlags

getElementFactory	back to summary
protected VkExternalMemoryProperties getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VkExternalMemoryProperties getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations