Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMemoryGetFdInfoKHR

extends Struct<VkMemoryGetFdInfoKHR>
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 describing a POSIX FD memory export operation.
Description

The properties of the file descriptor exported depend on the value of handleType. See VkExternalMemoryHandleTypeFlagBits for a description of the properties of the defined external memory handle types.

Note

The size of the exported file may be larger than the size requested by VkMemoryAllocateInfo::allocationSize. If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_DMA_BUF_BIT_EXT, then the application can query the file’s actual size with lseek.

Valid Usage
Valid Usage (Implicit)
See Also

GetMemoryFdKHR

Layout


struct VkMemoryGetFdInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkDeviceMemory memory;
    VkExternalMemoryHandleTypeFlagBits handleType;
}

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
HANDLETYPE

The struct member offsets.

public static final int
MEMORY

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

public
VkMemoryGetFdInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMemoryGetFdInfoKHR
calloc()

Returns a new VkMemoryGetFdInfoKHR instance allocated with memCalloc.

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

Returns a new VkMemoryGetFdInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkMemoryGetFdInfoKHR
callocStack()

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

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

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

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

Returns a new VkMemoryGetFdInfoKHR instance allocated with BufferUtils.

public static VkMemoryGetFdInfoKHR
create(long address)

Returns a new VkMemoryGetFdInfoKHR instance for the specified memory address.

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

Returns a new VkMemoryGetFdInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkMemoryGetFdInfoKHR.Buffer instance at the specified memory.

public static VkMemoryGetFdInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the type of handle requested.

public VkMemoryGetFdInfoKHR
handleType(int value)

Sets the specified value to the handleType field.

public static VkMemoryGetFdInfoKHR
malloc()

Returns a new VkMemoryGetFdInfoKHR instance allocated with memAlloc.

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

Returns a new VkMemoryGetFdInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkMemoryGetFdInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkMemoryGetFdInfoKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public long
memory()

the memory object from which the handle will be exported.

public VkMemoryGetFdInfoKHR
memory(long value)

Sets the specified value to the memory field.

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
nmemory(long struct)

Unsafe version of memory.

public static void
nmemory(long struct, long value)

Unsafe version of memory.

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

Sets the specified value to the pNext field.

public VkMemoryGetFdInfoKHR
set(int sType, long pNext, long memory, int handleType)

Initializes this struct with the specified values.

public VkMemoryGetFdInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkMemoryGetFdInfoKHR
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.

MEMORYback to summary
public static final int MEMORY

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

VkMemoryGetFdInfoKHRback to summary
protected VkMemoryGetFdInfoKHR(long address, ByteBuffer container)
VkMemoryGetFdInfoKHRback to summary
public VkMemoryGetFdInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMemoryGetFdInfoKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkMemoryGetFdInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkMemoryGetFdInfoKHR create(long address)

Returns a new VkMemoryGetFdInfoKHR instance for the specified memory address.

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

Returns a new VkMemoryGetFdInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMemoryGetFdInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMemoryGetFdInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkMemoryGetFdInfoKHR.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 type of handle requested.

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

Sets the specified value to the handleType field.

mallocback to summary
public static VkMemoryGetFdInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMemoryGetFdInfoKHR malloc(MemoryStack stack)

Returns a new VkMemoryGetFdInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
memoryback to summary
public long memory()

the memory object from which the handle will be exported.

Annotations
@NativeType:VkDeviceMemory
memoryback to summary
public VkMemoryGetFdInfoKHR memory(long value)

Sets the specified value to the memory field.

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.

nmemoryback to summary
public static long nmemory(long struct)

Unsafe version of memory.

nmemoryback to summary
public static void nmemory(long struct, long value)

Unsafe version of memory.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkMemoryGetFdInfoKHR set(VkMemoryGetFdInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkMemoryGetFdInfoKHR

the source struct

Returns:VkMemoryGetFdInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMemoryGetFdInfoKHR.Buffer

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

An array of VkMemoryGetFdInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkMemoryGetFdInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMemoryGetFdInfoKHR.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 VkMemoryGetFdInfoKHR
public int

Returns:

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

public VkMemoryGetFdInfoKHR.Buffer
handleType(int value)

Sets the specified value to the VkMemoryGetFdInfoKHR#handleType field.

public long

Returns:

the value of the VkMemoryGetFdInfoKHR#memory field.
memory
()

public VkMemoryGetFdInfoKHR.Buffer
memory(long value)

Sets the specified value to the VkMemoryGetFdInfoKHR#memory field.

public long

Returns:

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

public VkMemoryGetFdInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkMemoryGetFdInfoKHR#pNext field.

protected VkMemoryGetFdInfoKHR.Buffer
public int

Returns:

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

public VkMemoryGetFdInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkMemoryGetFdInfoKHR#sType field.

public VkMemoryGetFdInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMemoryGetFdInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkMemoryGetFdInfoKHR#handleType field.

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

Sets the specified value to the VkMemoryGetFdInfoKHR#handleType field.

memoryback to summary
public long memory()
Returns:long

the value of the VkMemoryGetFdInfoKHR#memory field.

Annotations
@NativeType:VkDeviceMemory
memoryback to summary
public VkMemoryGetFdInfoKHR.Buffer memory(long value)

Sets the specified value to the VkMemoryGetFdInfoKHR#memory field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkMemoryGetFdInfoKHR#pNext field.

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

Sets the specified value to the VkMemoryGetFdInfoKHR#pNext field.

selfback to summary
protected VkMemoryGetFdInfoKHR.Buffer self()

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

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

the value of the VkMemoryGetFdInfoKHR#sType field.

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

Sets the specified value to the VkMemoryGetFdInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR value to the VkMemoryGetFdInfoKHR#sType field.