Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExternalMemoryImageCreateInfo

extends Struct<VkExternalMemoryImageCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkExternalMemoryImageCreateInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Specify that an image may be backed by external memory.
Valid Usage (Implicit)

Layout


struct VkExternalMemoryImageCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkExternalMemoryHandleTypeFlags handleTypes;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkExternalMemoryImageCreateInfo.Buffer

An array of VkExternalMemoryImageCreateInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HANDLETYPES

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
VkExternalMemoryImageCreateInfo(long address, ByteBuffer container)

public
VkExternalMemoryImageCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExternalMemoryImageCreateInfo
calloc()

Returns a new VkExternalMemoryImageCreateInfo instance allocated with memCalloc.

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

Returns a new VkExternalMemoryImageCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkExternalMemoryImageCreateInfo
callocStack()

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

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

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

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

Returns a new VkExternalMemoryImageCreateInfo instance allocated with BufferUtils.

public static VkExternalMemoryImageCreateInfo
create(long address)

Returns a new VkExternalMemoryImageCreateInfo instance for the specified memory address.

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

Returns a new VkExternalMemoryImageCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkExternalMemoryImageCreateInfo.Buffer instance at the specified memory.

public static VkExternalMemoryImageCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
handleTypes()

zero or a bitmask of VkExternalMemoryHandleTypeFlagBits specifying one or more external memory handle types.

public VkExternalMemoryImageCreateInfo
handleTypes(int value)

Sets the specified value to the handleTypes field.

public static VkExternalMemoryImageCreateInfo
malloc()

Returns a new VkExternalMemoryImageCreateInfo instance allocated with memAlloc.

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

Returns a new VkExternalMemoryImageCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkExternalMemoryImageCreateInfo instance allocated on the specified MemoryStack.

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

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

public static VkExternalMemoryImageCreateInfo
mallocStack()

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

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

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

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

Unsafe version of handleTypes.

public static void
nhandleTypes(long struct, int value)

Unsafe version of handleTypes.

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 VkExternalMemoryImageCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkExternalMemoryImageCreateInfo
set(int sType, long pNext, int handleTypes)

Initializes this struct with the specified values.

public VkExternalMemoryImageCreateInfo

Returns:

this struct
set(VkExternalMemoryImageCreateInfo
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 VkExternalMemoryImageCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkExternalMemoryImageCreateInfo
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_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.

HANDLETYPESback to summary
public static final int HANDLETYPES

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

VkExternalMemoryImageCreateInfoback to summary
protected VkExternalMemoryImageCreateInfo(long address, ByteBuffer container)
VkExternalMemoryImageCreateInfoback to summary
public VkExternalMemoryImageCreateInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExternalMemoryImageCreateInfo calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExternalMemoryImageCreateInfo.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 VkExternalMemoryImageCreateInfo 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 VkExternalMemoryImageCreateInfo create()

Returns a new VkExternalMemoryImageCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkExternalMemoryImageCreateInfo create(long address)

Returns a new VkExternalMemoryImageCreateInfo instance for the specified memory address.

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

Returns a new VkExternalMemoryImageCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExternalMemoryImageCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExternalMemoryImageCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
handleTypesback to summary
public int handleTypes()

zero or a bitmask of VkExternalMemoryHandleTypeFlagBits specifying one or more external memory handle types.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlags
handleTypesback to summary
public VkExternalMemoryImageCreateInfo handleTypes(int value)

Sets the specified value to the handleTypes field.

mallocback to summary
public static VkExternalMemoryImageCreateInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExternalMemoryImageCreateInfo malloc(MemoryStack stack)

Returns a new VkExternalMemoryImageCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nhandleTypesback to summary
public static int nhandleTypes(long struct)

Unsafe version of handleTypes.

nhandleTypesback to summary
public static void nhandleTypes(long struct, int value)

Unsafe version of handleTypes.

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 VkExternalMemoryImageCreateInfo pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkExternalMemoryImageCreateInfo set(int sType, long pNext, int handleTypes)

Initializes this struct with the specified values.

setback to summary
public VkExternalMemoryImageCreateInfo set(VkExternalMemoryImageCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkExternalMemoryImageCreateInfo

the source struct

Returns:VkExternalMemoryImageCreateInfo

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 VkExternalMemoryImageCreateInfo sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkExternalMemoryImageCreateInfo.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkExternalMemoryImageCreateInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public int

Returns:

the value of the VkExternalMemoryImageCreateInfo#handleTypes field.
handleTypes()

public VkExternalMemoryImageCreateInfo.Buffer
handleTypes(int value)

Sets the specified value to the VkExternalMemoryImageCreateInfo#handleTypes field.

public long

Returns:

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

public VkExternalMemoryImageCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkExternalMemoryImageCreateInfo#pNext field.

protected VkExternalMemoryImageCreateInfo.Buffer
self()

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

public int

Returns:

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

public VkExternalMemoryImageCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkExternalMemoryImageCreateInfo#sType field.

public VkExternalMemoryImageCreateInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO value to the VkExternalMemoryImageCreateInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExternalMemoryImageCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExternalMemoryImageCreateInfo.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 VkExternalMemoryImageCreateInfo#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 VkExternalMemoryImageCreateInfo getElementFactory()

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

Annotations
@Override
handleTypesback to summary
public int handleTypes()
Returns:int

the value of the VkExternalMemoryImageCreateInfo#handleTypes field.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlags
handleTypesback to summary
public VkExternalMemoryImageCreateInfo.Buffer handleTypes(int value)

Sets the specified value to the VkExternalMemoryImageCreateInfo#handleTypes field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExternalMemoryImageCreateInfo#pNext field.

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

Sets the specified value to the VkExternalMemoryImageCreateInfo#pNext field.

selfback to summary
protected VkExternalMemoryImageCreateInfo.Buffer self()

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

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

the value of the VkExternalMemoryImageCreateInfo#sType field.

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

Sets the specified value to the VkExternalMemoryImageCreateInfo#sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO value to the VkExternalMemoryImageCreateInfo#sType field.