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
,NativeResource
,Pointer
- Direct Known Subclasses:
VkPhysicalDeviceExternalBufferInfoKHR
public class VkPhysicalDeviceExternalBufferInfo
extends Struct<VkPhysicalDeviceExternalBufferInfo>
implements NativeResource
Structure specifying buffer creation parameters.
Description
Only usage flags representable in VkBufferUsageFlagBits
are returned in this structure’s usage
. If a VkBufferUsageFlags2CreateInfoKHR
structure is present in the pNext
chain, all usage flags of the buffer are returned in VkBufferUsageFlags2CreateInfoKHR
::usage
.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO
pNext
must beNULL
or a pointer to a valid instance ofVkBufferUsageFlags2CreateInfoKHR
- The
sType
value of each struct in thepNext
chain must be unique flags
must be a valid combination ofVkBufferCreateFlagBits
valuesusage
must be a valid combination ofVkBufferUsageFlagBits
valuesusage
must not be 0handleType
must be a validVkExternalMemoryHandleTypeFlagBits
value
See Also
GetPhysicalDeviceExternalBufferProperties
, GetPhysicalDeviceExternalBufferPropertiesKHR
Layout
struct VkPhysicalDeviceExternalBufferInfo {
VkStructureType sType()
;
void const * pNext()
;
VkBufferCreateFlags flags()
;
VkBufferUsageFlags usage()
;
VkExternalMemoryHandleTypeFlagBits handleType()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkPhysicalDeviceExternalBufferInfo
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
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkPhysicalDeviceExternalBufferInfo
(ByteBuffer container) Creates aVkPhysicalDeviceExternalBufferInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkPhysicalDeviceExternalBufferInfo
instance for the specified memory address.create
(long address, int capacity) Create aVkPhysicalDeviceExternalBufferInfo.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
flags()
a bitmask ofVkBufferCreateFlagBits
describing additional parameters of the buffer, corresponding toVkBufferCreateInfo
::flags
.flags
(int value) Sets the specified value to theflags()
field.int
aVkExternalMemoryHandleTypeFlagBits
value specifying the memory handle type that will be used with the memory associated with the buffer.handleType
(int value) Sets the specified value to thehandleType()
field.malloc()
Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static int
nflags
(long struct) Unsafe version offlags()
.static void
nflags
(long struct, int value) Unsafe version offlags
.static int
nhandleType
(long struct) Unsafe version ofhandleType()
.static void
nhandleType
(long struct, int value) Unsafe version ofhandleType
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.static int
nusage
(long struct) Unsafe version ofusage()
.static void
nusage
(long struct, int value) Unsafe version ofusage
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.Prepends the specifiedVkBufferUsageFlags2CreateInfoKHR
value to thepNext
chain.set
(int sType, long pNext, int flags, int usage, int handleType) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO
value to thesType()
field.int
usage()
a bitmask ofVkBufferUsageFlagBits
describing the intended usage of the buffer, corresponding toVkBufferCreateInfo
::usage
.usage
(int value) Sets the specified value to theusage()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
USAGE
public static final int USAGEThe struct member offsets. -
HANDLETYPE
public static final int HANDLETYPEThe struct member offsets.
-
-
Constructor Details
-
VkPhysicalDeviceExternalBufferInfo
Creates aVkPhysicalDeviceExternalBufferInfo
instance at the current position of the specifiedByteBuffer
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
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkPhysicalDeviceExternalBufferInfo>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkBufferCreateFlagBits
describing additional parameters of the buffer, corresponding toVkBufferCreateInfo
::flags
. -
usage
public int usage()a bitmask ofVkBufferUsageFlagBits
describing the intended usage of the buffer, corresponding toVkBufferCreateInfo
::usage
. -
handleType
public int handleType()aVkExternalMemoryHandleTypeFlagBits
value specifying the memory handle type that will be used with the memory associated with the buffer. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
pNext
Prepends the specifiedVkBufferUsageFlags2CreateInfoKHR
value to thepNext
chain. -
flags
Sets the specified value to theflags()
field. -
usage
Sets the specified value to theusage()
field. -
handleType
Sets the specified value to thehandleType()
field. -
set
public VkPhysicalDeviceExternalBufferInfo set(int sType, long pNext, int flags, int usage, int handleType) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated withBufferUtils
. -
create
Returns a newVkPhysicalDeviceExternalBufferInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkPhysicalDeviceExternalBufferInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPhysicalDeviceExternalBufferInfo.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkPhysicalDeviceExternalBufferInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPhysicalDeviceExternalBufferInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceExternalBufferInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceExternalBufferInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType()
. -
npNext
public static long npNext(long struct) Unsafe version ofpNext()
. -
nflags
public static int nflags(long struct) Unsafe version offlags()
. -
nusage
public static int nusage(long struct) Unsafe version ofusage()
. -
nhandleType
public static int nhandleType(long struct) Unsafe version ofhandleType()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags
. -
nusage
public static void nusage(long struct, int value) Unsafe version ofusage
. -
nhandleType
public static void nhandleType(long struct, int value) Unsafe version ofhandleType
.
-