Package org.lwjgl.vulkan
Class VkPhysicalDeviceExternalImageFormatInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPhysicalDeviceExternalImageFormatInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkPhysicalDeviceExternalImageFormatInfoKHR
public class VkPhysicalDeviceExternalImageFormatInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying external image creation parameters.Description
If
handleType
is 0,GetPhysicalDeviceImageFormatProperties2
will behave as ifVkPhysicalDeviceExternalImageFormatInfo
was not present, andVkExternalImageFormatProperties
will be ignored.If
handleType
is not compatible with theformat
,type
,tiling
,usage
, andflags
specified inVkPhysicalDeviceImageFormatInfo2
, thenGetPhysicalDeviceImageFormatProperties2
returnsERROR_FORMAT_NOT_SUPPORTED
.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO
- If
handleType
is not 0,handleType
must be a validVkExternalMemoryHandleTypeFlagBits
value
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.handleType
– aVkExternalMemoryHandleTypeFlagBits
value specifying the memory handle type that will be used with the memory associated with the image.
Layout
struct VkPhysicalDeviceExternalImageFormatInfo { VkStructureType sType; void const * pNext; VkExternalMemoryHandleTypeFlagBits handleType; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPhysicalDeviceExternalImageFormatInfo.Buffer
An array ofVkPhysicalDeviceExternalImageFormatInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
HANDLETYPE
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceExternalImageFormatInfo(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceExternalImageFormatInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPhysicalDeviceExternalImageFormatInfo
calloc()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated withmemCalloc
.static VkPhysicalDeviceExternalImageFormatInfo.Buffer
calloc(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated withmemCalloc
.static VkPhysicalDeviceExternalImageFormatInfo
callocStack()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceExternalImageFormatInfo.Buffer
callocStack(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceExternalImageFormatInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceExternalImageFormatInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceExternalImageFormatInfo
create()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated withBufferUtils
.static VkPhysicalDeviceExternalImageFormatInfo.Buffer
create(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated withBufferUtils
.static VkPhysicalDeviceExternalImageFormatInfo
create(long address)
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance for the specified memory address.static VkPhysicalDeviceExternalImageFormatInfo.Buffer
create(long address, int capacity)
Create aVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance at the specified memory.static VkPhysicalDeviceExternalImageFormatInfo
createSafe(long address)
static VkPhysicalDeviceExternalImageFormatInfo.Buffer
createSafe(long address, int capacity)
int
handleType()
Returns the value of thehandleType
field.VkPhysicalDeviceExternalImageFormatInfo
handleType(int value)
Sets the specified value to thehandleType
field.static VkPhysicalDeviceExternalImageFormatInfo
malloc()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated withmemAlloc
.static VkPhysicalDeviceExternalImageFormatInfo.Buffer
malloc(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated withmemAlloc
.static VkPhysicalDeviceExternalImageFormatInfo
mallocStack()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceExternalImageFormatInfo.Buffer
mallocStack(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceExternalImageFormatInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPhysicalDeviceExternalImageFormatInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated on the specifiedMemoryStack
.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
.long
pNext()
Returns the value of thepNext
field.VkPhysicalDeviceExternalImageFormatInfo
pNext(long value)
Sets the specified value to thepNext
field.VkPhysicalDeviceExternalImageFormatInfo
set(int sType, long pNext, int handleType)
Initializes this struct with the specified values.VkPhysicalDeviceExternalImageFormatInfo
set(VkPhysicalDeviceExternalImageFormatInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPhysicalDeviceExternalImageFormatInfo
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkPhysicalDeviceExternalImageFormatInfo
public VkPhysicalDeviceExternalImageFormatInfo(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceExternalImageFormatInfo
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
handleType
public int handleType()
Returns the value of thehandleType
field.
-
sType
public VkPhysicalDeviceExternalImageFormatInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPhysicalDeviceExternalImageFormatInfo pNext(long value)
Sets the specified value to thepNext
field.
-
handleType
public VkPhysicalDeviceExternalImageFormatInfo handleType(int value)
Sets the specified value to thehandleType
field.
-
set
public VkPhysicalDeviceExternalImageFormatInfo set(int sType, long pNext, int handleType)
Initializes this struct with the specified values.
-
set
public VkPhysicalDeviceExternalImageFormatInfo set(VkPhysicalDeviceExternalImageFormatInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPhysicalDeviceExternalImageFormatInfo malloc()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceExternalImageFormatInfo calloc()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceExternalImageFormatInfo create()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated withBufferUtils
.
-
create
public static VkPhysicalDeviceExternalImageFormatInfo create(long address)
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceExternalImageFormatInfo createSafe(long address)
-
malloc
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer create(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPhysicalDeviceExternalImageFormatInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPhysicalDeviceExternalImageFormatInfo mallocStack()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPhysicalDeviceExternalImageFormatInfo callocStack()
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceExternalImageFormatInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceExternalImageFormatInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer mallocStack(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
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
.
-
nhandleType
public static void nhandleType(long struct, int value)
Unsafe version ofhandleType
.
-
-