Package org.lwjgl.vulkan

Class VkExportMemoryAllocateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExportMemoryAllocateInfo>

org.lwjgl.vulkan.VkExportMemoryAllocateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkExportMemoryAllocateInfoKHR

public class VkExportMemoryAllocateInfo
extends Struct<VkExportMemoryAllocateInfo>
implements NativeResource

Specify exportable handle types for a device memory object.

Valid Usage

• The bits in handleTypes must be supported and compatible, as reported by VkExternalImageFormatProperties or VkExternalBufferProperties

Valid Usage (Implicit)

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

Layout

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

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

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
VkExportMemoryAllocateInfo(ByteBuffer container)	Creates a VkExportMemoryAllocateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkExportMemoryAllocateInfo	calloc()	Returns a new VkExportMemoryAllocateInfo instance allocated with memCalloc.
static VkExportMemoryAllocateInfo.Buffer	calloc(int capacity)	Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated with memCalloc.
static VkExportMemoryAllocateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportMemoryAllocateInfo	calloc(MemoryStack stack)	Returns a new VkExportMemoryAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportMemoryAllocateInfo	callocStack()	Deprecated.
static VkExportMemoryAllocateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkExportMemoryAllocateInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkExportMemoryAllocateInfo	callocStack(MemoryStack stack)	Deprecated.
static VkExportMemoryAllocateInfo	create()	Returns a new VkExportMemoryAllocateInfo instance allocated with BufferUtils.
static VkExportMemoryAllocateInfo.Buffer	create(int capacity)	Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated with BufferUtils.
static VkExportMemoryAllocateInfo	create(long address)	Returns a new VkExportMemoryAllocateInfo instance for the specified memory address.
static VkExportMemoryAllocateInfo.Buffer	create(long address, int capacity)	Create a VkExportMemoryAllocateInfo.Buffer instance at the specified memory.
static VkExportMemoryAllocateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static VkExportMemoryAllocateInfo.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 memory handle types the application can export from the resulting allocation.
VkExportMemoryAllocateInfo	handleTypes(int value)	Sets the specified value to the handleTypes() field.
static VkExportMemoryAllocateInfo	malloc()	Returns a new VkExportMemoryAllocateInfo instance allocated with memAlloc.
static VkExportMemoryAllocateInfo.Buffer	malloc(int capacity)	Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated with memAlloc.
static VkExportMemoryAllocateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated on the specified MemoryStack.
static VkExportMemoryAllocateInfo	malloc(MemoryStack stack)	Returns a new VkExportMemoryAllocateInfo instance allocated on the specified MemoryStack.
static VkExportMemoryAllocateInfo	mallocStack()	Deprecated.
static VkExportMemoryAllocateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkExportMemoryAllocateInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkExportMemoryAllocateInfo	mallocStack(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.
VkExportMemoryAllocateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkExportMemoryAllocateInfo	set(int sType, long pNext, int handleTypes)	Initializes this struct with the specified values.
VkExportMemoryAllocateInfo	set(VkExportMemoryAllocateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkExportMemoryAllocateInfo	sType(int value)	Sets the specified value to the sType() field.
VkExportMemoryAllocateInfo	sType$Default()	Sets the STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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

VkExportMemoryAllocateInfo

public VkExportMemoryAllocateInfo(ByteBuffer container)

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

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkExportMemoryAllocateInfo>

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 memory handle types the application can export from the resulting allocation. The application can request multiple handle types for the same allocation.

sType

public VkExportMemoryAllocateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExportMemoryAllocateInfo sType$Default()

Sets the STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO value to the sType() field.

pNext

public VkExportMemoryAllocateInfo pNext(long value)

Sets the specified value to the pNext() field.

handleTypes

public VkExportMemoryAllocateInfo handleTypes(int value)

Sets the specified value to the handleTypes() field.

set

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

Initializes this struct with the specified values.

set

public VkExportMemoryAllocateInfo set(VkExportMemoryAllocateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExportMemoryAllocateInfo malloc()

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

calloc

public static VkExportMemoryAllocateInfo calloc()

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

create

public static VkExportMemoryAllocateInfo create()

Returns a new VkExportMemoryAllocateInfo instance allocated with BufferUtils.

create

public static VkExportMemoryAllocateInfo create(long address)

Returns a new VkExportMemoryAllocateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkExportMemoryAllocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExportMemoryAllocateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExportMemoryAllocateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExportMemoryAllocateInfo.Buffer create(int capacity)

Returns a new VkExportMemoryAllocateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExportMemoryAllocateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkExportMemoryAllocateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkExportMemoryAllocateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkExportMemoryAllocateInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkExportMemoryAllocateInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkExportMemoryAllocateInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkExportMemoryAllocateInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkExportMemoryAllocateInfo malloc(MemoryStack stack)

Returns a new VkExportMemoryAllocateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkExportMemoryAllocateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkExportMemoryAllocateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkExportMemoryAllocateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkExportMemoryAllocateInfo.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.