Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceExternalImageFormatInfo

extends Struct<VkPhysicalDeviceExternalImageFormatInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceExternalImageFormatInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying external image creation parameters.
Description

If handleType is 0, GetPhysicalDeviceImageFormatProperties2 will behave as if VkPhysicalDeviceExternalImageFormatInfo was not present, and VkExternalImageFormatProperties will be ignored.

If handleType is not compatible with the format, type, tiling, usage, and flags specified in VkPhysicalDeviceImageFormatInfo2, then GetPhysicalDeviceImageFormatProperties2 returns ERROR_FORMAT_NOT_SUPPORTED.

Valid Usage (Implicit)

Layout


struct VkPhysicalDeviceExternalImageFormatInfo {
    VkStructureType sType;
    void const * pNext;
    VkExternalMemoryHandleTypeFlagBits handleType;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkPhysicalDeviceExternalImageFormatInfo.Buffer

An array of VkPhysicalDeviceExternalImageFormatInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HANDLETYPE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkPhysicalDeviceExternalImageFormatInfo(long address, ByteBuffer container)

public
VkPhysicalDeviceExternalImageFormatInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceExternalImageFormatInfo
calloc()

Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkPhysicalDeviceExternalImageFormatInfo
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkPhysicalDeviceExternalImageFormatInfo
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 VkPhysicalDeviceExternalImageFormatInfo
create()

Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated with BufferUtils.

public static VkPhysicalDeviceExternalImageFormatInfo
create(long address)

Returns a new VkPhysicalDeviceExternalImageFormatInfo instance for the specified memory address.

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

Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceExternalImageFormatInfo.Buffer instance at the specified memory.

public static VkPhysicalDeviceExternalImageFormatInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the memory handle type that will be used with the memory associated with the image.

public VkPhysicalDeviceExternalImageFormatInfo
handleType(int value)

Sets the specified value to the handleType field.

public static VkPhysicalDeviceExternalImageFormatInfo
malloc()

Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated on the specified MemoryStack.

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

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

public static VkPhysicalDeviceExternalImageFormatInfo
mallocStack()

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

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

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

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

Unsafe version of handleType.

public static void
nhandleType(long struct, int value)

Unsafe version of handleType.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPhysicalDeviceExternalImageFormatInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkPhysicalDeviceExternalImageFormatInfo
set(int sType, long pNext, int handleType)

Initializes this struct with the specified values.

public VkPhysicalDeviceExternalImageFormatInfo

Returns:

this struct
set(VkPhysicalDeviceExternalImageFormatInfo
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkPhysicalDeviceExternalImageFormatInfo
sType(int value)

Sets the specified value to the sType field.

public VkPhysicalDeviceExternalImageFormatInfo
sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO value to the sType field.

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.

HANDLETYPEback to summary
public static final int HANDLETYPE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkPhysicalDeviceExternalImageFormatInfoback to summary
protected VkPhysicalDeviceExternalImageFormatInfo(long address, ByteBuffer container)
VkPhysicalDeviceExternalImageFormatInfoback to summary
public VkPhysicalDeviceExternalImageFormatInfo(ByteBuffer container)

Creates a VkPhysicalDeviceExternalImageFormatInfo 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 VkPhysicalDeviceExternalImageFormatInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceExternalImageFormatInfo calloc(MemoryStack stack)

Returns a new VkPhysicalDeviceExternalImageFormatInfo 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 VkPhysicalDeviceExternalImageFormatInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkPhysicalDeviceExternalImageFormatInfo 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 VkPhysicalDeviceExternalImageFormatInfo create()

Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceExternalImageFormatInfo create(long address)

Returns a new VkPhysicalDeviceExternalImageFormatInfo instance for the specified memory address.

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

Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceExternalImageFormatInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceExternalImageFormatInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
handleTypeback to summary
public int handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the memory handle type that will be used with the memory associated with the image.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagBits
handleTypeback to summary
public VkPhysicalDeviceExternalImageFormatInfo handleType(int value)

Sets the specified value to the handleType field.

mallocback to summary
public static VkPhysicalDeviceExternalImageFormatInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceExternalImageFormatInfo malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nhandleTypeback to summary
public static int nhandleType(long struct)

Unsafe version of handleType.

nhandleTypeback to summary
public static void nhandleType(long struct, int value)

Unsafe version of handleType.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkPhysicalDeviceExternalImageFormatInfo pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceExternalImageFormatInfo set(int sType, long pNext, int handleType)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceExternalImageFormatInfo set(VkPhysicalDeviceExternalImageFormatInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceExternalImageFormatInfo

the source struct

Returns:VkPhysicalDeviceExternalImageFormatInfo

this struct

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceExternalImageFormatInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkPhysicalDeviceExternalImageFormatInfo sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceExternalImageFormatInfo.Buffer

extends StructBuffer<VkPhysicalDeviceExternalImageFormatInfo, VkPhysicalDeviceExternalImageFormatInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceExternalImageFormatInfoKHR.Buffer
An array of VkPhysicalDeviceExternalImageFormatInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceExternalImageFormatInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceExternalImageFormatInfo.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
protected VkPhysicalDeviceExternalImageFormatInfo
getElementFactory()

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

public int

Returns:

the value of the VkPhysicalDeviceExternalImageFormatInfo#handleType field.
handleType()

public VkPhysicalDeviceExternalImageFormatInfo.Buffer
handleType(int value)

Sets the specified value to the VkPhysicalDeviceExternalImageFormatInfo#handleType field.

public long

Returns:

the value of the VkPhysicalDeviceExternalImageFormatInfo#pNext field.
pNext()

public VkPhysicalDeviceExternalImageFormatInfo.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceExternalImageFormatInfo#pNext field.

protected VkPhysicalDeviceExternalImageFormatInfo.Buffer
self()

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

public int

Returns:

the value of the VkPhysicalDeviceExternalImageFormatInfo#sType field.
sType()

public VkPhysicalDeviceExternalImageFormatInfo.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceExternalImageFormatInfo#sType field.

public VkPhysicalDeviceExternalImageFormatInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO value to the VkPhysicalDeviceExternalImageFormatInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceExternalImageFormatInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceExternalImageFormatInfo.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 VkPhysicalDeviceExternalImageFormatInfo#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

getElementFactoryback to summary
protected VkPhysicalDeviceExternalImageFormatInfo getElementFactory()

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

Annotations
@Override
handleTypeback to summary
public int handleType()
Returns:int

the value of the VkPhysicalDeviceExternalImageFormatInfo#handleType field.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagBits
handleTypeback to summary
public VkPhysicalDeviceExternalImageFormatInfo.Buffer handleType(int value)

Sets the specified value to the VkPhysicalDeviceExternalImageFormatInfo#handleType field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceExternalImageFormatInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkPhysicalDeviceExternalImageFormatInfo.Buffer pNext(long value)

Sets the specified value to the VkPhysicalDeviceExternalImageFormatInfo#pNext field.

selfback to summary
protected VkPhysicalDeviceExternalImageFormatInfo.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkPhysicalDeviceExternalImageFormatInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceExternalImageFormatInfo.Buffer sType(int value)

Sets the specified value to the VkPhysicalDeviceExternalImageFormatInfo#sType field.

sType$Defaultback to summary
public VkPhysicalDeviceExternalImageFormatInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO value to the VkPhysicalDeviceExternalImageFormatInfo#sType field.