Package org.lwjgl.vulkan

Class VkExternalMemoryBufferCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExternalMemoryBufferCreateInfo>

org.lwjgl.vulkan.VkExternalMemoryBufferCreateInfo

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkExternalMemoryBufferCreateInfoKHR

public class VkExternalMemoryBufferCreateInfo
extends org.lwjgl.system.Struct<VkExternalMemoryBufferCreateInfo>
implements org.lwjgl.system.NativeResource

Specify that a buffer may be backed by external memory.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXTERNAL_MEMORY_BUFFER_CREATE_INFO
• handleTypes must be a valid combination of VkExternalMemoryHandleTypeFlagBits values

Layout

 struct VkExternalMemoryBufferCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkExternalMemoryHandleTypeFlags handleTypes();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkExternalMemoryBufferCreateInfo.Buffer	An array of VkExternalMemoryBufferCreateInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	HANDLETYPES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkExternalMemoryBufferCreateInfo(ByteBuffer container)	Creates a VkExternalMemoryBufferCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkExternalMemoryBufferCreateInfo	calloc()	Returns a new VkExternalMemoryBufferCreateInfo instance allocated with memCalloc.
static VkExternalMemoryBufferCreateInfo.Buffer	calloc(int capacity)	Returns a new VkExternalMemoryBufferCreateInfo.Buffer instance allocated with memCalloc.
static VkExternalMemoryBufferCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalMemoryBufferCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalMemoryBufferCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalMemoryBufferCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalMemoryBufferCreateInfo	callocStack()	Deprecated.
static VkExternalMemoryBufferCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkExternalMemoryBufferCreateInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExternalMemoryBufferCreateInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExternalMemoryBufferCreateInfo	create()	Returns a new VkExternalMemoryBufferCreateInfo instance allocated with BufferUtils.
static VkExternalMemoryBufferCreateInfo.Buffer	create(int capacity)	Returns a new VkExternalMemoryBufferCreateInfo.Buffer instance allocated with BufferUtils.
static VkExternalMemoryBufferCreateInfo	create(long address)	Returns a new VkExternalMemoryBufferCreateInfo instance for the specified memory address.
static VkExternalMemoryBufferCreateInfo.Buffer	create(long address, int capacity)	Create a VkExternalMemoryBufferCreateInfo.Buffer instance at the specified memory.
static @Nullable VkExternalMemoryBufferCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExternalMemoryBufferCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	handleTypes()	zero or a bitmask of VkExternalMemoryHandleTypeFlagBits specifying one or more external memory handle types.
VkExternalMemoryBufferCreateInfo	handleTypes(int value)	Sets the specified value to the handleTypes() field.
static VkExternalMemoryBufferCreateInfo	malloc()	Returns a new VkExternalMemoryBufferCreateInfo instance allocated with memAlloc.
static VkExternalMemoryBufferCreateInfo.Buffer	malloc(int capacity)	Returns a new VkExternalMemoryBufferCreateInfo.Buffer instance allocated with memAlloc.
static VkExternalMemoryBufferCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalMemoryBufferCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkExternalMemoryBufferCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExternalMemoryBufferCreateInfo instance allocated on the specified MemoryStack.
static VkExternalMemoryBufferCreateInfo	mallocStack()	Deprecated.
static VkExternalMemoryBufferCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkExternalMemoryBufferCreateInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExternalMemoryBufferCreateInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nhandleTypes(long struct)	Unsafe version of handleTypes().
static void	nhandleTypes(long struct, int value)	Unsafe version of handleTypes.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkExternalMemoryBufferCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkExternalMemoryBufferCreateInfo	set(int sType, long pNext, int handleTypes)	Initializes this struct with the specified values.
VkExternalMemoryBufferCreateInfo	set(VkExternalMemoryBufferCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkExternalMemoryBufferCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkExternalMemoryBufferCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_BUFFER_CREATE_INFO value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

HANDLETYPES

public static final int HANDLETYPES

The struct member offsets.

Constructor Details

VkExternalMemoryBufferCreateInfo

public VkExternalMemoryBufferCreateInfo(ByteBuffer container)

Creates a VkExternalMemoryBufferCreateInfo 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkExternalMemoryBufferCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

handleTypes

public int handleTypes()

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

sType

public VkExternalMemoryBufferCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExternalMemoryBufferCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_BUFFER_CREATE_INFO value to the sType() field.

pNext

public VkExternalMemoryBufferCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

handleTypes

public VkExternalMemoryBufferCreateInfo handleTypes(int value)

Sets the specified value to the handleTypes() field.

set

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

Initializes this struct with the specified values.

set

public VkExternalMemoryBufferCreateInfo set(VkExternalMemoryBufferCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExternalMemoryBufferCreateInfo malloc()

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

calloc

public static VkExternalMemoryBufferCreateInfo calloc()

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

create

public static VkExternalMemoryBufferCreateInfo create()

Returns a new VkExternalMemoryBufferCreateInfo instance allocated with BufferUtils.

create

public static VkExternalMemoryBufferCreateInfo create(long address)

Returns a new VkExternalMemoryBufferCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkExternalMemoryBufferCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExternalMemoryBufferCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExternalMemoryBufferCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExternalMemoryBufferCreateInfo.Buffer create(int capacity)

Returns a new VkExternalMemoryBufferCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkExternalMemoryBufferCreateInfo.Buffer create(long address,
 int capacity)

Create a VkExternalMemoryBufferCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkExternalMemoryBufferCreateInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkExternalMemoryBufferCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkExternalMemoryBufferCreateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkExternalMemoryBufferCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkExternalMemoryBufferCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkExternalMemoryBufferCreateInfo.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkExternalMemoryBufferCreateInfo.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkExternalMemoryBufferCreateInfo.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkExternalMemoryBufferCreateInfo.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkExternalMemoryBufferCreateInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkExternalMemoryBufferCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkExternalMemoryBufferCreateInfo calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkExternalMemoryBufferCreateInfo.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkExternalMemoryBufferCreateInfo.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nhandleTypes

public static int nhandleTypes(long struct)

Unsafe version of handleTypes().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nhandleTypes

public static void nhandleTypes(long struct,
 int value)

Unsafe version of handleTypes.