Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExternalImageFormatPropertiesNV

extends Struct<VkExternalImageFormatPropertiesNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying external image format properties.
See Also

VkImageFormatProperties, GetPhysicalDeviceExternalImageFormatPropertiesNV

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField 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
IMAGEFORMATPROPERTIES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkExternalImageFormatPropertiesNV(ByteBuffer container)

Creates a VkExternalImageFormatPropertiesNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkExternalImageFormatPropertiesNV
calloc()

Returns a new VkExternalImageFormatPropertiesNV instance allocated with memCalloc.

public static VkExternalImageFormatPropertiesNV.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated with memCalloc.

public static VkExternalImageFormatPropertiesNV
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkExternalImageFormatPropertiesNV.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkExternalImageFormatPropertiesNV
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatPropertiesNV
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatPropertiesNV.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatPropertiesNV.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
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.

protected VkExternalImageFormatPropertiesNV
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 VkExternalImageFormatPropertiesNV
create()

Returns a new VkExternalImageFormatPropertiesNV instance allocated with BufferUtils.

public static VkExternalImageFormatPropertiesNV
create(long address)

Returns a new VkExternalImageFormatPropertiesNV instance for the specified memory address.

public static VkExternalImageFormatPropertiesNV.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated with BufferUtils.

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

Create a VkExternalImageFormatPropertiesNV.Buffer instance at the specified memory.

public static VkExternalImageFormatPropertiesNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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.

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.

public VkImageFormatProperties
imageFormatProperties()

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

public static VkExternalImageFormatPropertiesNV
malloc()

Returns a new VkExternalImageFormatPropertiesNV instance allocated with memAlloc.

public static VkExternalImageFormatPropertiesNV.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated with memAlloc.

public static VkExternalImageFormatPropertiesNV
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkExternalImageFormatPropertiesNV instance allocated on the specified MemoryStack.

public static VkExternalImageFormatPropertiesNV.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkExternalImageFormatPropertiesNV
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatPropertiesNV
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatPropertiesNV.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalImageFormatPropertiesNV.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
ncompatibleHandleTypes(long struct)

Unsafe version of compatibleHandleTypes.

public static int
public static int
nexternalMemoryFeatures(long struct)

Unsafe version of externalMemoryFeatures.

public static VkImageFormatProperties
nimageFormatProperties(long struct)

Unsafe version of imageFormatProperties.

public int
sizeof()

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

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

COMPATIBLEHANDLETYPESback to summary
public static final int COMPATIBLEHANDLETYPES

The struct member offsets.

EXPORTFROMIMPORTEDHANDLETYPESback to summary
public static final int EXPORTFROMIMPORTEDHANDLETYPES

The struct member offsets.

EXTERNALMEMORYFEATURESback to summary
public static final int EXTERNALMEMORYFEATURES

The struct member offsets.

IMAGEFORMATPROPERTIESback to summary
public static final int IMAGEFORMATPROPERTIES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkExternalImageFormatPropertiesNVback to summary
protected VkExternalImageFormatPropertiesNV(long address, ByteBuffer container)
VkExternalImageFormatPropertiesNVback to summary
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 Detail

callocback to summary
public static VkExternalImageFormatPropertiesNV calloc()

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

callocback to summary
public static VkExternalImageFormatPropertiesNV.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExternalImageFormatPropertiesNV calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkExternalImageFormatPropertiesNV.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkExternalImageFormatPropertiesNV callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExternalImageFormatPropertiesNV callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExternalImageFormatPropertiesNV.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExternalImageFormatPropertiesNV.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
compatibleHandleTypesback to summary
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

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagsNV
createback to summary
protected VkExternalImageFormatPropertiesNV 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
createback to summary
public static VkExternalImageFormatPropertiesNV create()

Returns a new VkExternalImageFormatPropertiesNV instance allocated with BufferUtils.

createback to summary
public static VkExternalImageFormatPropertiesNV create(long address)

Returns a new VkExternalImageFormatPropertiesNV instance for the specified memory address.

createback to summary
public static VkExternalImageFormatPropertiesNV.Buffer create(int capacity)

Returns a new VkExternalImageFormatPropertiesNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExternalImageFormatPropertiesNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExternalImageFormatPropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkExternalImageFormatPropertiesNV.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
exportFromImportedHandleTypesback to summary
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.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagsNV
externalMemoryFeaturesback to summary
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.

Annotations
@NativeType:VkExternalMemoryFeatureFlagsNV
imageFormatPropertiesback to summary
public VkImageFormatProperties imageFormatProperties()

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

mallocback to summary
public static VkExternalImageFormatPropertiesNV malloc()

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

mallocback to summary
public static VkExternalImageFormatPropertiesNV.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExternalImageFormatPropertiesNV malloc(MemoryStack stack)

Returns a new VkExternalImageFormatPropertiesNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkExternalImageFormatPropertiesNV.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkExternalImageFormatPropertiesNV mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkExternalImageFormatPropertiesNV mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkExternalImageFormatPropertiesNV.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkExternalImageFormatPropertiesNV.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
ncompatibleHandleTypesback to summary
public static int ncompatibleHandleTypes(long struct)

Unsafe version of compatibleHandleTypes.

nexportFromImportedHandleTypesback to summary
public static int nexportFromImportedHandleTypes(long struct)

Unsafe version of exportFromImportedHandleTypes.

nexternalMemoryFeaturesback to summary
public static int nexternalMemoryFeatures(long struct)

Unsafe version of externalMemoryFeatures.

nimageFormatPropertiesback to summary
public static VkImageFormatProperties nimageFormatProperties(long struct)

Unsafe version of imageFormatProperties.

sizeofback to summary
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 VkExternalImageFormatPropertiesNV.Buffer

extends StructBuffer<VkExternalImageFormatPropertiesNV, VkExternalImageFormatPropertiesNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkExternalImageFormatPropertiesNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkExternalImageFormatPropertiesNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExternalImageFormatPropertiesNV.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 TypeMethod and Description
public int
public int
public int
protected VkExternalImageFormatPropertiesNV
public VkImageFormatProperties
protected VkExternalImageFormatPropertiesNV.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExternalImageFormatPropertiesNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExternalImageFormatPropertiesNV.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 VkExternalImageFormatPropertiesNV#SIZEOF, and its mark will be undefined.

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

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

Method Detail

compatibleHandleTypesback to summary
public int compatibleHandleTypes()
Returns:int

the value of the VkExternalImageFormatPropertiesNV#compatibleHandleTypes field.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagsNV
exportFromImportedHandleTypesback to summary
public int exportFromImportedHandleTypes()
Returns:int

the value of the VkExternalImageFormatPropertiesNV#exportFromImportedHandleTypes field.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagsNV
externalMemoryFeaturesback to summary
public int externalMemoryFeatures()
Returns:int

the value of the VkExternalImageFormatPropertiesNV#externalMemoryFeatures field.

Annotations
@NativeType:VkExternalMemoryFeatureFlagsNV
getElementFactoryback to summary
protected VkExternalImageFormatPropertiesNV getElementFactory()

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

Annotations
@Override
imageFormatPropertiesback to summary
public VkImageFormatProperties imageFormatProperties()
Returns:VkImageFormatProperties

a VkImageFormatProperties view of the VkExternalImageFormatPropertiesNV#imageFormatProperties field.

selfback to summary
protected VkExternalImageFormatPropertiesNV.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override