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.NativeResourceStructure specifying external image creation parameters.Description
If
handleTypeis 0,GetPhysicalDeviceImageFormatProperties2will behave as ifVkPhysicalDeviceExternalImageFormatInfowas not present, andVkExternalImageFormatPropertieswill be ignored.If
handleTypeis not compatible with theformat,type,tiling,usage, andflagsspecified inVkPhysicalDeviceImageFormatInfo2, thenGetPhysicalDeviceImageFormatProperties2returnsERROR_FORMAT_NOT_SUPPORTED.Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO- If
handleTypeis not 0,handleTypemust be a validVkExternalMemoryHandleTypeFlagBitsvalue
Layout
struct VkPhysicalDeviceExternalImageFormatInfo { VkStructureTypesType(); void const *pNext(); VkExternalMemoryHandleTypeFlagBitshandleType(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPhysicalDeviceExternalImageFormatInfo.BufferAn array ofVkPhysicalDeviceExternalImageFormatInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intHANDLETYPE
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceExternalImageFormatInfo(java.nio.ByteBuffer container)Creates aVkPhysicalDeviceExternalImageFormatInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkPhysicalDeviceExternalImageFormatInfocalloc()Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated withmemCalloc.static VkPhysicalDeviceExternalImageFormatInfo.Buffercalloc(int capacity)Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated withmemCalloc.static VkPhysicalDeviceExternalImageFormatInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceExternalImageFormatInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceExternalImageFormatInfocallocStack()Deprecated.static VkPhysicalDeviceExternalImageFormatInfo.BuffercallocStack(int capacity)Deprecated.static VkPhysicalDeviceExternalImageFormatInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceExternalImageFormatInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceExternalImageFormatInfocreate()Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated withBufferUtils.static VkPhysicalDeviceExternalImageFormatInfo.Buffercreate(int capacity)Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated withBufferUtils.static VkPhysicalDeviceExternalImageFormatInfocreate(long address)Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance for the specified memory address.static VkPhysicalDeviceExternalImageFormatInfo.Buffercreate(long address, int capacity)Create aVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance at the specified memory.static VkPhysicalDeviceExternalImageFormatInfocreateSafe(long address)static VkPhysicalDeviceExternalImageFormatInfo.BuffercreateSafe(long address, int capacity)inthandleType()aVkExternalMemoryHandleTypeFlagBitsvalue specifying the memory handle type that will be used with the memory associated with the image.VkPhysicalDeviceExternalImageFormatInfohandleType(int value)Sets the specified value to thehandleType()field.static VkPhysicalDeviceExternalImageFormatInfomalloc()Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated withmemAlloc.static VkPhysicalDeviceExternalImageFormatInfo.Buffermalloc(int capacity)Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated withmemAlloc.static VkPhysicalDeviceExternalImageFormatInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceExternalImageFormatInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceExternalImageFormatInfomallocStack()Deprecated.static VkPhysicalDeviceExternalImageFormatInfo.BuffermallocStack(int capacity)Deprecated.static VkPhysicalDeviceExternalImageFormatInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceExternalImageFormatInfomallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intnhandleType(long struct)Unsafe version ofhandleType().static voidnhandleType(long struct, int value)Unsafe version ofhandleType.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.VkPhysicalDeviceExternalImageFormatInfopNext(long value)Sets the specified value to thepNext()field.VkPhysicalDeviceExternalImageFormatInfoset(int sType, long pNext, int handleType)Initializes this struct with the specified values.VkPhysicalDeviceExternalImageFormatInfoset(VkPhysicalDeviceExternalImageFormatInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkPhysicalDeviceExternalImageFormatInfosType(int value)Sets the specified value to thesType()field.VkPhysicalDeviceExternalImageFormatInfosType$Default()Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFOvalue to thesType()field.
-
-
-
Constructor Detail
-
VkPhysicalDeviceExternalImageFormatInfo
public VkPhysicalDeviceExternalImageFormatInfo(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceExternalImageFormatInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
handleType
public int handleType()
aVkExternalMemoryHandleTypeFlagBitsvalue specifying the memory handle type that will be used with the memory associated with the image.
-
sType
public VkPhysicalDeviceExternalImageFormatInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkPhysicalDeviceExternalImageFormatInfo sType$Default()
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFOvalue 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 newVkPhysicalDeviceExternalImageFormatInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceExternalImageFormatInfo calloc()
Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceExternalImageFormatInfo create()
Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated withBufferUtils.
-
create
public static VkPhysicalDeviceExternalImageFormatInfo create(long address)
Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceExternalImageFormatInfo createSafe(long address)
-
malloc
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer create(int capacity)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPhysicalDeviceExternalImageFormatInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkPhysicalDeviceExternalImageFormatInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceExternalImageFormatInfo callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPhysicalDeviceExternalImageFormatInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceExternalImageFormatInfo callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPhysicalDeviceExternalImageFormatInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceExternalImageFormatInfo.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPhysicalDeviceExternalImageFormatInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceExternalImageFormatInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkPhysicalDeviceExternalImageFormatInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPhysicalDeviceExternalImageFormatInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceExternalImageFormatInfo.Bufferinstance allocated on the specifiedMemoryStackand 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.
-
-