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
,NativeResource
,Pointer
- Direct Known Subclasses:
VkExternalMemoryImageCreateInfoKHR
public class VkExternalMemoryImageCreateInfo
extends Struct<VkExternalMemoryImageCreateInfo>
implements NativeResource
Specify that an image may be backed by external memory.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO
handleTypes
must be a valid combination ofVkExternalMemoryHandleTypeFlagBits
values
Layout
struct VkExternalMemoryImageCreateInfo {
VkStructureType sType()
;
void const * pNext()
;
VkExternalMemoryHandleTypeFlags handleTypes()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkExternalMemoryImageCreateInfo
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 size in bytes.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
ConstructorDescriptionVkExternalMemoryImageCreateInfo
(ByteBuffer container) Creates aVkExternalMemoryImageCreateInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkExternalMemoryImageCreateInfo
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkExternalMemoryImageCreateInfo
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 newVkExternalMemoryImageCreateInfo
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkExternalMemoryImageCreateInfo
instance for the specified memory address.create
(long address, int capacity) Create aVkExternalMemoryImageCreateInfo.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
zero or a bitmask ofVkExternalMemoryHandleTypeFlagBits
specifying one or more external memory handle types.handleTypes
(int value) Sets the specified value to thehandleTypes()
field.malloc()
Returns a newVkExternalMemoryImageCreateInfo
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkExternalMemoryImageCreateInfo
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static int
nhandleTypes
(long struct) Unsafe version ofhandleTypes()
.static void
nhandleTypes
(long struct, int value) Unsafe version ofhandleTypes
.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
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, int handleTypes) 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_EXTERNAL_MEMORY_IMAGE_CREATE_INFO
value to thesType()
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. -
HANDLETYPES
public static final int HANDLETYPESThe struct member offsets.
-
-
Constructor Details
-
VkExternalMemoryImageCreateInfo
Creates aVkExternalMemoryImageCreateInfo
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<VkExternalMemoryImageCreateInfo>
-
sType
public int sType()aVkStructureType
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 ofVkExternalMemoryHandleTypeFlagBits
specifying one or more external memory handle types. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
handleTypes
Sets the specified value to thehandleTypes()
field. -
set
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 newVkExternalMemoryImageCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkExternalMemoryImageCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkExternalMemoryImageCreateInfo
instance allocated withBufferUtils
. -
create
Returns a newVkExternalMemoryImageCreateInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkExternalMemoryImageCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkExternalMemoryImageCreateInfo.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 VkExternalMemoryImageCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkExternalMemoryImageCreateInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkExternalMemoryImageCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkExternalMemoryImageCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkExternalMemoryImageCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkExternalMemoryImageCreateInfo.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()
. -
nhandleTypes
public static int nhandleTypes(long struct) Unsafe version ofhandleTypes()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nhandleTypes
public static void nhandleTypes(long struct, int value) Unsafe version ofhandleTypes
.
-