Package org.lwjgl.vulkan

Class VkExternalImageFormatPropertiesNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExternalImageFormatPropertiesNV>

org.lwjgl.vulkan.VkExternalImageFormatPropertiesNV

All Implemented Interfaces:

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

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

Structure specifying external image format properties.

See Also

VkImageFormatProperties, GetPhysicalDeviceExternalImageFormatPropertiesNV

Layout

 struct VkExternalImageFormatPropertiesNV {
     VkImageFormatProperties imageFormatProperties();
     VkExternalMemoryFeatureFlagsNV externalMemoryFeatures();
     VkExternalMemoryHandleTypeFlagsNV exportFromImportedHandleTypes();
     VkExternalMemoryHandleTypeFlagsNV compatibleHandleTypes();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkExternalImageFormatPropertiesNV	calloc()	Returns a new VkExternalImageFormatPropertiesNV instance allocated with memCalloc.
static VkExternalImageFormatPropertiesNV.Buffer	calloc(int capacity)	Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated with memCalloc.
static VkExternalImageFormatPropertiesNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalImageFormatPropertiesNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalImageFormatPropertiesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalImageFormatPropertiesNV	callocStack()	Deprecated.
static VkExternalImageFormatPropertiesNV.Buffer	callocStack(int capacity)	Deprecated.
static VkExternalImageFormatPropertiesNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExternalImageFormatPropertiesNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
int	compatibleHandleTypes()	a bitmask of VkExternalMemoryHandleTypeFlagBitsNV containing a bit set for every external handle type that may be specified simultaneously with the handle type specified by GetPhysicalDeviceExternalImageFormatPropertiesNV::externalHandleType when calling AllocateMemory, or 0 if the external memory handle type is 0.
static VkExternalImageFormatPropertiesNV	create()	Returns a new VkExternalImageFormatPropertiesNV instance allocated with BufferUtils.
static VkExternalImageFormatPropertiesNV.Buffer	create(int capacity)	Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated with BufferUtils.
static VkExternalImageFormatPropertiesNV	create(long address)	Returns a new VkExternalImageFormatPropertiesNV instance for the specified memory address.
static VkExternalImageFormatPropertiesNV.Buffer	create(long address, int capacity)	Create a VkExternalImageFormatPropertiesNV.Buffer instance at the specified memory.
static @Nullable VkExternalImageFormatPropertiesNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExternalImageFormatPropertiesNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	exportFromImportedHandleTypes()	a bitmask of VkExternalMemoryHandleTypeFlagBitsNV containing a bit set for every external handle type that may be used to create memory from which the handles of the type specified in GetPhysicalDeviceExternalImageFormatPropertiesNV::externalHandleType can be exported, or 0 if the external memory handle type is 0.
int	externalMemoryFeatures()	a bitmask of VkExternalMemoryFeatureFlagBitsNV, indicating properties of the external memory handle type (GetPhysicalDeviceExternalImageFormatPropertiesNV::externalHandleType) being queried, or 0 if the external memory handle type is 0.
VkImageFormatProperties	imageFormatProperties()	will be filled in as when calling GetPhysicalDeviceImageFormatProperties, but the values returned may vary depending on the external handle type requested.
static VkExternalImageFormatPropertiesNV	malloc()	Returns a new VkExternalImageFormatPropertiesNV instance allocated with memAlloc.
static VkExternalImageFormatPropertiesNV.Buffer	malloc(int capacity)	Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated with memAlloc.
static VkExternalImageFormatPropertiesNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated on the specified MemoryStack.
static VkExternalImageFormatPropertiesNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalImageFormatPropertiesNV instance allocated on the specified MemoryStack.
static VkExternalImageFormatPropertiesNV	mallocStack()	Deprecated.
static VkExternalImageFormatPropertiesNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkExternalImageFormatPropertiesNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExternalImageFormatPropertiesNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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().
static VkImageFormatProperties	nimageFormatProperties(long struct)	Unsafe version of imageFormatProperties().
int	sizeof()

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.

IMAGEFORMATPROPERTIES

public static final int IMAGEFORMATPROPERTIES

The struct member offsets.

EXTERNALMEMORYFEATURES

public static final int EXTERNALMEMORYFEATURES

The struct member offsets.

EXPORTFROMIMPORTEDHANDLETYPES

public static final int EXPORTFROMIMPORTEDHANDLETYPES

The struct member offsets.

COMPATIBLEHANDLETYPES

public static final int COMPATIBLEHANDLETYPES

The struct member offsets.

Constructor Details

VkExternalImageFormatPropertiesNV

public VkExternalImageFormatPropertiesNV(ByteBuffer container)

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

imageFormatProperties

public VkImageFormatProperties imageFormatProperties()

will be filled in as when calling GetPhysicalDeviceImageFormatProperties, but the values returned may vary depending on the external handle type requested.

externalMemoryFeatures

public int externalMemoryFeatures()

a bitmask of VkExternalMemoryFeatureFlagBitsNV, indicating properties of the external memory handle type (GetPhysicalDeviceExternalImageFormatPropertiesNV::externalHandleType) being queried, or 0 if the external memory handle type is 0.

exportFromImportedHandleTypes

public int exportFromImportedHandleTypes()

a bitmask of VkExternalMemoryHandleTypeFlagBitsNV containing a bit set for every external handle type that may be used to create memory from which the handles of the type specified in GetPhysicalDeviceExternalImageFormatPropertiesNV::externalHandleType can be exported, or 0 if the external memory handle type is 0.

compatibleHandleTypes

public int compatibleHandleTypes()

a bitmask of VkExternalMemoryHandleTypeFlagBitsNV containing a bit set for every external handle type that may be specified simultaneously with the handle type specified by GetPhysicalDeviceExternalImageFormatPropertiesNV::externalHandleType when calling AllocateMemory, or 0 if the external memory handle type is 0. compatibleHandleTypes will always contain GetPhysicalDeviceExternalImageFormatPropertiesNV::externalHandleType

malloc

public static VkExternalImageFormatPropertiesNV malloc()

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

calloc

public static VkExternalImageFormatPropertiesNV calloc()

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

create

public static VkExternalImageFormatPropertiesNV create()

Returns a new VkExternalImageFormatPropertiesNV instance allocated with BufferUtils.

create

public static VkExternalImageFormatPropertiesNV create(long address)

Returns a new VkExternalImageFormatPropertiesNV instance for the specified memory address.

createSafe

public static @Nullable VkExternalImageFormatPropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExternalImageFormatPropertiesNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExternalImageFormatPropertiesNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExternalImageFormatPropertiesNV.Buffer create(int capacity)

Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExternalImageFormatPropertiesNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkExternalImageFormatPropertiesNV mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkExternalImageFormatPropertiesNV callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkExternalImageFormatPropertiesNV mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkExternalImageFormatPropertiesNV callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkExternalImageFormatPropertiesNV.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkExternalImageFormatPropertiesNV.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkExternalImageFormatPropertiesNV.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkExternalImageFormatPropertiesNV.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

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

Returns a new VkExternalImageFormatPropertiesNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkExternalImageFormatPropertiesNV.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

nimageFormatProperties

public static VkImageFormatProperties nimageFormatProperties(long struct)

Unsafe version of imageFormatProperties().

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().