Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExternalMemoryImageCreateInfoNV

extends Struct<VkExternalMemoryImageCreateInfoNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
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 VkExternalMemoryImageCreateInfoNV {
    VkStructureType sType;
    void const * pNext;
    VkExternalMemoryHandleTypeFlagsNV handleTypes;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkExternalMemoryImageCreateInfoNV.Buffer

An array of VkExternalMemoryImageCreateInfoNV 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
VkExternalMemoryImageCreateInfoNV(long address, ByteBuffer container)

public
VkExternalMemoryImageCreateInfoNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExternalMemoryImageCreateInfoNV
calloc()

Returns a new VkExternalMemoryImageCreateInfoNV instance allocated with memCalloc.

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

Returns a new VkExternalMemoryImageCreateInfoNV.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkExternalMemoryImageCreateInfoNV
callocStack()

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

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

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

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

Returns a new VkExternalMemoryImageCreateInfoNV instance allocated with BufferUtils.

public static VkExternalMemoryImageCreateInfoNV
create(long address)

Returns a new VkExternalMemoryImageCreateInfoNV instance for the specified memory address.

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

Returns a new VkExternalMemoryImageCreateInfoNV.Buffer instance allocated with BufferUtils.

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

Create a VkExternalMemoryImageCreateInfoNV.Buffer instance at the specified memory.

public static VkExternalMemoryImageCreateInfoNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
handleTypes()

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

public VkExternalMemoryImageCreateInfoNV
handleTypes(int value)

Sets the specified value to the handleTypes field.

public static VkExternalMemoryImageCreateInfoNV
malloc()

Returns a new VkExternalMemoryImageCreateInfoNV instance allocated with memAlloc.

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

Returns a new VkExternalMemoryImageCreateInfoNV.Buffer instance allocated with memAlloc.

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

Returns a new VkExternalMemoryImageCreateInfoNV instance allocated on the specified MemoryStack.

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

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

public static VkExternalMemoryImageCreateInfoNV
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkExternalMemoryImageCreateInfoNV.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 VkExternalMemoryImageCreateInfoNV
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkExternalMemoryImageCreateInfoNV

Returns:

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

Sets the specified value to the sType field.

public VkExternalMemoryImageCreateInfoNV
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO_NV 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

VkExternalMemoryImageCreateInfoNVback to summary
protected VkExternalMemoryImageCreateInfoNV(long address, ByteBuffer container)
VkExternalMemoryImageCreateInfoNVback to summary
public VkExternalMemoryImageCreateInfoNV(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExternalMemoryImageCreateInfoNV calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkExternalMemoryImageCreateInfoNV instance allocated with BufferUtils.

createback to summary
public static VkExternalMemoryImageCreateInfoNV create(long address)

Returns a new VkExternalMemoryImageCreateInfoNV instance for the specified memory address.

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

Returns a new VkExternalMemoryImageCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExternalMemoryImageCreateInfoNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExternalMemoryImageCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkExternalMemoryImageCreateInfoNV.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 VkExternalMemoryHandleTypeFlagBitsNV specifying one or more external memory handle types.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagsNV
handleTypesback to summary
public VkExternalMemoryImageCreateInfoNV handleTypes(int value)

Sets the specified value to the handleTypes field.

mallocback to summary
public static VkExternalMemoryImageCreateInfoNV malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExternalMemoryImageCreateInfoNV malloc(MemoryStack stack)

Returns a new VkExternalMemoryImageCreateInfoNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkExternalMemoryImageCreateInfoNV.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 VkExternalMemoryImageCreateInfoNV pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkExternalMemoryImageCreateInfoNV set(VkExternalMemoryImageCreateInfoNV src)

Copies the specified struct data to this struct.

Parameters
src:VkExternalMemoryImageCreateInfoNV

the source struct

Returns:VkExternalMemoryImageCreateInfoNV

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO_NV value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkExternalMemoryImageCreateInfoNV.Buffer

extends StructBuffer<VkExternalMemoryImageCreateInfoNV, VkExternalMemoryImageCreateInfoNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkExternalMemoryImageCreateInfoNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkExternalMemoryImageCreateInfoNV
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public int

Returns:

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

public VkExternalMemoryImageCreateInfoNV.Buffer
handleTypes(int value)

Sets the specified value to the VkExternalMemoryImageCreateInfoNV#handleTypes field.

public long

Returns:

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

public VkExternalMemoryImageCreateInfoNV.Buffer
pNext(long value)

Sets the specified value to the VkExternalMemoryImageCreateInfoNV#pNext field.

protected VkExternalMemoryImageCreateInfoNV.Buffer
self()

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

public int

Returns:

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

public VkExternalMemoryImageCreateInfoNV.Buffer
sType(int value)

Sets the specified value to the VkExternalMemoryImageCreateInfoNV#sType field.

public VkExternalMemoryImageCreateInfoNV.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO_NV value to the VkExternalMemoryImageCreateInfoNV#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExternalMemoryImageCreateInfoNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkExternalMemoryImageCreateInfoNV#handleTypes field.

Annotations
@NativeType:VkExternalMemoryHandleTypeFlagsNV
handleTypesback to summary
public VkExternalMemoryImageCreateInfoNV.Buffer handleTypes(int value)

Sets the specified value to the VkExternalMemoryImageCreateInfoNV#handleTypes field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExternalMemoryImageCreateInfoNV#pNext field.

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

Sets the specified value to the VkExternalMemoryImageCreateInfoNV#pNext field.

selfback to summary
protected VkExternalMemoryImageCreateInfoNV.Buffer self()

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

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

the value of the VkExternalMemoryImageCreateInfoNV#sType field.

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

Sets the specified value to the VkExternalMemoryImageCreateInfoNV#sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO_NV value to the VkExternalMemoryImageCreateInfoNV#sType field.