Package org.lwjgl.vulkan

Class VkExternalMemoryImageCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExternalMemoryImageCreateInfo>

org.lwjgl.vulkan.VkExternalMemoryImageCreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkExternalMemoryImageCreateInfoKHR

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

Specify that an image may be backed by external memory.

Valid Usage (Implicit)

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

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkExternalMemoryImageCreateInfo.Buffer	An array of VkExternalMemoryImageCreateInfo 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
VkExternalMemoryImageCreateInfo(ByteBuffer container)	Creates a VkExternalMemoryImageCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

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

VkExternalMemoryImageCreateInfo

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 Details

sizeof

public int sizeof()

Specified by:

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

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

Sets the specified value to the sType() field.

sType$Default

public VkExternalMemoryImageCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO value to the sType() field.

pNext

public VkExternalMemoryImageCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

handleTypes

public VkExternalMemoryImageCreateInfo handleTypes(int value)

Sets the specified value to the handleTypes() field.

set

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

Initializes this struct with the specified values.

set

public VkExternalMemoryImageCreateInfo set(VkExternalMemoryImageCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExternalMemoryImageCreateInfo malloc()

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

calloc

public static VkExternalMemoryImageCreateInfo calloc()

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

create

public static VkExternalMemoryImageCreateInfo create()

Returns a new VkExternalMemoryImageCreateInfo instance allocated with BufferUtils.

create

public static VkExternalMemoryImageCreateInfo create(long address)

Returns a new VkExternalMemoryImageCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkExternalMemoryImageCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExternalMemoryImageCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExternalMemoryImageCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExternalMemoryImageCreateInfo.Buffer create(int capacity)

Returns a new VkExternalMemoryImageCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExternalMemoryImageCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkExternalMemoryImageCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkExternalMemoryImageCreateInfo callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkExternalMemoryImageCreateInfo.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 VkExternalMemoryImageCreateInfo.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 VkExternalMemoryImageCreateInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkExternalMemoryImageCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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