Package org.lwjgl.vulkan

Class VkPhysicalDeviceExternalBufferInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceExternalBufferInfo>

org.lwjgl.vulkan.VkPhysicalDeviceExternalBufferInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPhysicalDeviceExternalBufferInfoKHR

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

Structure specifying buffer creation parameters.

Description

Only usage flags representable in VkBufferUsageFlagBits are returned in this structure’s usage. If the pNext chain includes a VkBufferUsageFlags2CreateInfo structure, all usage flags of the buffer are returned in VkBufferUsageFlags2CreateInfo::usage.

Valid Usage

• If the pNext chain does not include a VkBufferUsageFlags2CreateInfo structure, usage must be a valid combination of VkBufferUsageFlagBits values
• If the pNext chain does not include a VkBufferUsageFlags2CreateInfo structure, usage must not be 0

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO
• pNext must be NULL or a pointer to a valid instance of VkBufferUsageFlags2CreateInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of VkBufferCreateFlagBits values
• handleType must be a valid VkExternalMemoryHandleTypeFlagBits value

See Also

GetPhysicalDeviceExternalBufferProperties, GetPhysicalDeviceExternalBufferPropertiesKHR

Layout

 struct VkPhysicalDeviceExternalBufferInfo {
     VkStructureType sType();
     void const * pNext();
     VkBufferCreateFlags flags();
     VkBufferUsageFlags usage();
     VkExternalMemoryHandleTypeFlagBits handleType();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceExternalBufferInfo.Buffer	An array of VkPhysicalDeviceExternalBufferInfo 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	FLAGS	The struct member offsets.
static final int	HANDLETYPE	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.
static final int	USAGE	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
VkPhysicalDeviceExternalBufferInfo(ByteBuffer container)	Creates a VkPhysicalDeviceExternalBufferInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceExternalBufferInfo	calloc()	Returns a new VkPhysicalDeviceExternalBufferInfo instance allocated with memCalloc.
static VkPhysicalDeviceExternalBufferInfo.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceExternalBufferInfo.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceExternalBufferInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExternalBufferInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceExternalBufferInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExternalBufferInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceExternalBufferInfo	callocStack()	Deprecated.
static VkPhysicalDeviceExternalBufferInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceExternalBufferInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceExternalBufferInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceExternalBufferInfo	create()	Returns a new VkPhysicalDeviceExternalBufferInfo instance allocated with BufferUtils.
static VkPhysicalDeviceExternalBufferInfo.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceExternalBufferInfo.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceExternalBufferInfo	create(long address)	Returns a new VkPhysicalDeviceExternalBufferInfo instance for the specified memory address.
static VkPhysicalDeviceExternalBufferInfo.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceExternalBufferInfo.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceExternalBufferInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceExternalBufferInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkBufferCreateFlagBits describing additional parameters of the buffer, corresponding to VkBufferCreateInfo::flags.
VkPhysicalDeviceExternalBufferInfo	flags(int value)	Sets the specified value to the flags() field.
int	handleType()	a VkExternalMemoryHandleTypeFlagBits value specifying the memory handle type that will be used with the memory associated with the buffer.
VkPhysicalDeviceExternalBufferInfo	handleType(int value)	Sets the specified value to the handleType() field.
static VkPhysicalDeviceExternalBufferInfo	malloc()	Returns a new VkPhysicalDeviceExternalBufferInfo instance allocated with memAlloc.
static VkPhysicalDeviceExternalBufferInfo.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceExternalBufferInfo.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceExternalBufferInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExternalBufferInfo.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceExternalBufferInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceExternalBufferInfo instance allocated on the specified MemoryStack.
static VkPhysicalDeviceExternalBufferInfo	mallocStack()	Deprecated.
static VkPhysicalDeviceExternalBufferInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceExternalBufferInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceExternalBufferInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static int	nhandleType(long struct)	Unsafe version of handleType().
static void	nhandleType(long struct, int value)	Unsafe version of handleType.
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.
static int	nusage(long struct)	Unsafe version of usage().
static void	nusage(long struct, int value)	Unsafe version of usage.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceExternalBufferInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceExternalBufferInfo	pNext(VkBufferUsageFlags2CreateInfo value)	Prepends the specified VkBufferUsageFlags2CreateInfo value to the pNext chain.
VkPhysicalDeviceExternalBufferInfo	pNext(VkBufferUsageFlags2CreateInfoKHR value)	Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.
VkPhysicalDeviceExternalBufferInfo	set(int sType, long pNext, int flags, int usage, int handleType)	Initializes this struct with the specified values.
VkPhysicalDeviceExternalBufferInfo	set(VkPhysicalDeviceExternalBufferInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceExternalBufferInfo	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceExternalBufferInfo	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO value to the sType() field.
int	usage()	a bitmask of VkBufferUsageFlagBits describing the intended usage of the buffer, corresponding to VkBufferCreateInfo::usage.
VkPhysicalDeviceExternalBufferInfo	usage(int value)	Sets the specified value to the usage() 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.

FLAGS

public static final int FLAGS

The struct member offsets.

USAGE

public static final int USAGE

The struct member offsets.

HANDLETYPE

public static final int HANDLETYPE

The struct member offsets.

Constructor Details

VkPhysicalDeviceExternalBufferInfo

public VkPhysicalDeviceExternalBufferInfo(ByteBuffer container)

Creates a VkPhysicalDeviceExternalBufferInfo 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<VkPhysicalDeviceExternalBufferInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

a bitmask of VkBufferCreateFlagBits describing additional parameters of the buffer, corresponding to VkBufferCreateInfo::flags.

usage

public int usage()

a bitmask of VkBufferUsageFlagBits describing the intended usage of the buffer, corresponding to VkBufferCreateInfo::usage.

handleType

public int handleType()

a VkExternalMemoryHandleTypeFlagBits value specifying the memory handle type that will be used with the memory associated with the buffer.

sType

public VkPhysicalDeviceExternalBufferInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceExternalBufferInfo sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO value to the sType() field.

pNext

public VkPhysicalDeviceExternalBufferInfo pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkPhysicalDeviceExternalBufferInfo pNext(VkBufferUsageFlags2CreateInfo value)

Prepends the specified VkBufferUsageFlags2CreateInfo value to the pNext chain.

pNext

public VkPhysicalDeviceExternalBufferInfo pNext(VkBufferUsageFlags2CreateInfoKHR value)

Prepends the specified VkBufferUsageFlags2CreateInfoKHR value to the pNext chain.

flags

public VkPhysicalDeviceExternalBufferInfo flags(int value)

Sets the specified value to the flags() field.

usage

public VkPhysicalDeviceExternalBufferInfo usage(int value)

Sets the specified value to the usage() field.

handleType

public VkPhysicalDeviceExternalBufferInfo handleType(int value)

Sets the specified value to the handleType() field.

set

public VkPhysicalDeviceExternalBufferInfo set(int sType,
 long pNext,
 int flags,
 int usage,
 int handleType)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceExternalBufferInfo set(VkPhysicalDeviceExternalBufferInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceExternalBufferInfo malloc()

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

calloc

public static VkPhysicalDeviceExternalBufferInfo calloc()

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

create

public static VkPhysicalDeviceExternalBufferInfo create()

Returns a new VkPhysicalDeviceExternalBufferInfo instance allocated with BufferUtils.

create

public static VkPhysicalDeviceExternalBufferInfo create(long address)

Returns a new VkPhysicalDeviceExternalBufferInfo instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceExternalBufferInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceExternalBufferInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceExternalBufferInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceExternalBufferInfo.Buffer create(int capacity)

Returns a new VkPhysicalDeviceExternalBufferInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceExternalBufferInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceExternalBufferInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceExternalBufferInfo callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Returns a new VkPhysicalDeviceExternalBufferInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

nusage

public static int nusage(long struct)

Unsafe version of usage().

nhandleType

public static int nhandleType(long struct)

Unsafe version of handleType().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nusage

public static void nusage(long struct,
 int value)

Unsafe version of usage.

nhandleType

public static void nhandleType(long struct,
 int value)

Unsafe version of handleType.