VkPhysicalDeviceExternalImageFormatInfo (LWJGL 3.2.4 SNAPSHOT

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 if VkPhysicalDeviceExternalImageFormatInfo was not present, and VkExternalImageFormatProperties will be ignored.

If handleType is not compatible with the format, type, tiling, usage, and flags specified in VkPhysicalDeviceImageFormatInfo2, then GetPhysicalDeviceImageFormatProperties2 returns ERROR_FORMAT_NOT_SUPPORTED.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO
- If handleType is not 0, handleType must be a valid VkExternalMemoryHandleTypeFlagBits value
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- handleType – a VkExternalMemoryHandleTypeFlagBits 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 and Description

static class VkPhysicalDeviceExternalImageFormatInfo.Buffer
An array of VkPhysicalDeviceExternalImageFormatInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkPhysicalDeviceExternalImageFormatInfo.Buffer` An array of `VkPhysicalDeviceExternalImageFormatInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`HANDLETYPE` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` 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 and Description
`VkPhysicalDeviceExternalImageFormatInfo(java.nio.ByteBuffer container)` Creates a `VkPhysicalDeviceExternalImageFormatInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkPhysicalDeviceExternalImageFormatInfo`	`calloc()` Returns a new `VkPhysicalDeviceExternalImageFormatInfo` instance allocated with `memCalloc`.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`calloc(int capacity)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo.Buffer` instance allocated with `memCalloc`.
`static VkPhysicalDeviceExternalImageFormatInfo`	`callocStack()` Returns a new `VkPhysicalDeviceExternalImageFormatInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceExternalImageFormatInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceExternalImageFormatInfo`	`create()` Returns a new `VkPhysicalDeviceExternalImageFormatInfo` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`create(int capacity)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo.Buffer` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceExternalImageFormatInfo`	`create(long address)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo` instance for the specified memory address.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`create(long address, int capacity)` Create a `VkPhysicalDeviceExternalImageFormatInfo.Buffer` instance at the specified memory.
`static VkPhysicalDeviceExternalImageFormatInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`handleType()` Returns the value of the `handleType` field.
`VkPhysicalDeviceExternalImageFormatInfo`	`handleType(int value)` Sets the specified value to the `handleType` field.
`static VkPhysicalDeviceExternalImageFormatInfo`	`malloc()` Returns a new `VkPhysicalDeviceExternalImageFormatInfo` instance allocated with `memAlloc`.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`malloc(int capacity)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo.Buffer` instance allocated with `memAlloc`.
`static VkPhysicalDeviceExternalImageFormatInfo`	`mallocStack()` Returns a new `VkPhysicalDeviceExternalImageFormatInfo` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceExternalImageFormatInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPhysicalDeviceExternalImageFormatInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceExternalImageFormatInfo` instance allocated on the specified `MemoryStack`.
`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`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPhysicalDeviceExternalImageFormatInfo`	`pNext(long value)` Sets the specified value to the `pNext` 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 the `sType` field.
`VkPhysicalDeviceExternalImageFormatInfo`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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.
  - HANDLETYPE
```
public static final int HANDLETYPE
```
    The struct member offsets.
- Constructor Detail
  - VkPhysicalDeviceExternalImageFormatInfo
```
public VkPhysicalDeviceExternalImageFormatInfo(java.nio.ByteBuffer container)
```
    Creates a VkPhysicalDeviceExternalImageFormatInfo 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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - handleType
```
public int handleType()
```
    Returns the value of the handleType field.
  - sType
```
public VkPhysicalDeviceExternalImageFormatInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPhysicalDeviceExternalImageFormatInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - handleType
```
public VkPhysicalDeviceExternalImageFormatInfo handleType(int value)
```
    Sets the specified value to the handleType 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 new VkPhysicalDeviceExternalImageFormatInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPhysicalDeviceExternalImageFormatInfo calloc()
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPhysicalDeviceExternalImageFormatInfo create()
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated with BufferUtils.
  - create
```
public static VkPhysicalDeviceExternalImageFormatInfo create(long address)
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPhysicalDeviceExternalImageFormatInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer malloc(int capacity)
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer calloc(int capacity)
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer create(int capacity)
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer create(long address,
                                                                    int capacity)
```
    Create a VkPhysicalDeviceExternalImageFormatInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer createSafe(long address,
                                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPhysicalDeviceExternalImageFormatInfo mallocStack()
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPhysicalDeviceExternalImageFormatInfo callocStack()
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPhysicalDeviceExternalImageFormatInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPhysicalDeviceExternalImageFormatInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo instance allocated on the specified MemoryStack 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 new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer callocStack(int capacity)
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated on the thread-local MemoryStack 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 new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceExternalImageFormatInfo.Buffer callocStack(int capacity,
                                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceExternalImageFormatInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - 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.
  - nhandleType
```
public static void nhandleType(long struct,
                               int value)
```
    Unsafe version of handleType.

Class VkPhysicalDeviceExternalImageFormatInfo

Description

Valid Usage (Implicit)

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

HANDLETYPE

Constructor Detail

VkPhysicalDeviceExternalImageFormatInfo

Method Detail

sizeof

sType

pNext

handleType

sType

pNext

handleType

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nhandleType

nsType

npNext

nhandleType