VkExternalImageFormatProperties (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkExternalImageFormatProperties

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkExternalImageFormatPropertiesKHR
```
public class VkExternalImageFormatProperties
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying supported external handle properties.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES
See Also

VkExternalMemoryProperties

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- externalMemoryProperties – a VkExternalMemoryProperties structure specifying various capabilities of the external handle type when used with the specified image creation parameters.
Layout
```
 struct VkExternalImageFormatProperties {
     VkStructureType sType;
     void * pNext;
     VkExternalMemoryProperties externalMemoryProperties;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkExternalImageFormatProperties.Buffer
An array of VkExternalImageFormatProperties 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`	`VkExternalImageFormatProperties.Buffer` An array of `VkExternalImageFormatProperties` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`EXTERNALMEMORYPROPERTIES` 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
`VkExternalImageFormatProperties(java.nio.ByteBuffer container)` Creates a `VkExternalImageFormatProperties` 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 VkExternalImageFormatProperties`	`calloc()` Returns a new `VkExternalImageFormatProperties` instance allocated with `memCalloc`.
`static VkExternalImageFormatProperties.Buffer`	`calloc(int capacity)` Returns a new `VkExternalImageFormatProperties.Buffer` instance allocated with `memCalloc`.
`static VkExternalImageFormatProperties`	`callocStack()` Returns a new `VkExternalImageFormatProperties` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkExternalImageFormatProperties.Buffer`	`callocStack(int capacity)` Returns a new `VkExternalImageFormatProperties.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkExternalImageFormatProperties.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkExternalImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkExternalImageFormatProperties`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkExternalImageFormatProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkExternalImageFormatProperties`	`create()` Returns a new `VkExternalImageFormatProperties` instance allocated with `BufferUtils`.
`static VkExternalImageFormatProperties.Buffer`	`create(int capacity)` Returns a new `VkExternalImageFormatProperties.Buffer` instance allocated with `BufferUtils`.
`static VkExternalImageFormatProperties`	`create(long address)` Returns a new `VkExternalImageFormatProperties` instance for the specified memory address.
`static VkExternalImageFormatProperties.Buffer`	`create(long address, int capacity)` Create a `VkExternalImageFormatProperties.Buffer` instance at the specified memory.
`static VkExternalImageFormatProperties`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkExternalImageFormatProperties.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`VkExternalMemoryProperties`	`externalMemoryProperties()` Returns a `VkExternalMemoryProperties` view of the `externalMemoryProperties` field.
`static VkExternalImageFormatProperties`	`malloc()` Returns a new `VkExternalImageFormatProperties` instance allocated with `memAlloc`.
`static VkExternalImageFormatProperties.Buffer`	`malloc(int capacity)` Returns a new `VkExternalImageFormatProperties.Buffer` instance allocated with `memAlloc`.
`static VkExternalImageFormatProperties`	`mallocStack()` Returns a new `VkExternalImageFormatProperties` instance allocated on the thread-local `MemoryStack`.
`static VkExternalImageFormatProperties.Buffer`	`mallocStack(int capacity)` Returns a new `VkExternalImageFormatProperties.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkExternalImageFormatProperties.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkExternalImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkExternalImageFormatProperties`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkExternalImageFormatProperties` instance allocated on the specified `MemoryStack`.
`static VkExternalMemoryProperties`	`nexternalMemoryProperties(long struct)` Unsafe version of `externalMemoryProperties()`.
`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.
`VkExternalImageFormatProperties`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkExternalImageFormatProperties`	`set(int sType, long pNext)` Initializes this struct with the specified values.
`VkExternalImageFormatProperties`	`set(VkExternalImageFormatProperties src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkExternalImageFormatProperties`	`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.
  - EXTERNALMEMORYPROPERTIES
```
public static final int EXTERNALMEMORYPROPERTIES
```
    The struct member offsets.
- Constructor Detail
  - VkExternalImageFormatProperties
```
public VkExternalImageFormatProperties(java.nio.ByteBuffer container)
```
    Creates a VkExternalImageFormatProperties 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.
  - externalMemoryProperties
```
public VkExternalMemoryProperties externalMemoryProperties()
```
    Returns a VkExternalMemoryProperties view of the externalMemoryProperties field.
  - sType
```
public VkExternalImageFormatProperties sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkExternalImageFormatProperties pNext(long value)
```
    Sets the specified value to the pNext field.
  - set
```
public VkExternalImageFormatProperties set(int sType,
                                           long pNext)
```
    Initializes this struct with the specified values.
  - set
```
public VkExternalImageFormatProperties set(VkExternalImageFormatProperties src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkExternalImageFormatProperties malloc()
```
    Returns a new VkExternalImageFormatProperties instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkExternalImageFormatProperties calloc()
```
    Returns a new VkExternalImageFormatProperties instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkExternalImageFormatProperties create()
```
    Returns a new VkExternalImageFormatProperties instance allocated with BufferUtils.
  - create
```
public static VkExternalImageFormatProperties create(long address)
```
    Returns a new VkExternalImageFormatProperties instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkExternalImageFormatProperties createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkExternalImageFormatProperties.Buffer malloc(int capacity)
```
    Returns a new VkExternalImageFormatProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkExternalImageFormatProperties.Buffer calloc(int capacity)
```
    Returns a new VkExternalImageFormatProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkExternalImageFormatProperties.Buffer create(int capacity)
```
    Returns a new VkExternalImageFormatProperties.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkExternalImageFormatProperties.Buffer create(long address,
                                                            int capacity)
```
    Create a VkExternalImageFormatProperties.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkExternalImageFormatProperties.Buffer createSafe(long address,
                                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkExternalImageFormatProperties mallocStack()
```
    Returns a new VkExternalImageFormatProperties instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkExternalImageFormatProperties callocStack()
```
    Returns a new VkExternalImageFormatProperties instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkExternalImageFormatProperties mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkExternalImageFormatProperties instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkExternalImageFormatProperties callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkExternalImageFormatProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkExternalImageFormatProperties.Buffer mallocStack(int capacity)
```
    Returns a new VkExternalImageFormatProperties.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkExternalImageFormatProperties.Buffer callocStack(int capacity)
```
    Returns a new VkExternalImageFormatProperties.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkExternalImageFormatProperties.Buffer mallocStack(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkExternalImageFormatProperties.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkExternalImageFormatProperties.Buffer callocStack(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkExternalImageFormatProperties.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().
  - nexternalMemoryProperties
```
public static VkExternalMemoryProperties nexternalMemoryProperties(long struct)
```
    Unsafe version of externalMemoryProperties().
  - 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.

Class VkExternalImageFormatProperties

Valid Usage (Implicit)

See Also

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

EXTERNALMEMORYPROPERTIES

Constructor Detail

VkExternalImageFormatProperties

Method Detail

sizeof

sType

pNext

externalMemoryProperties

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nexternalMemoryProperties

nsType

npNext