Package org.lwjgl.vulkan

Class VkExternalImageFormatProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExternalImageFormatProperties>

org.lwjgl.vulkan.VkExternalImageFormatProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkExternalImageFormatPropertiesKHR

public class VkExternalImageFormatProperties
extends Struct<VkExternalImageFormatProperties>
implements NativeResource

Structure specifying supported external handle properties.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES

See Also

VkExternalMemoryProperties

Layout

 struct VkExternalImageFormatProperties {
     VkStructureType sType();
     void * pNext();
     VkExternalMemoryProperties externalMemoryProperties();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkExternalImageFormatProperties.Buffer	An array of VkExternalImageFormatProperties 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

Fields

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

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkExternalImageFormatProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalImageFormatProperties	calloc(MemoryStack stack)	Returns a new VkExternalImageFormatProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalImageFormatProperties	callocStack()	Deprecated.
static VkExternalImageFormatProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkExternalImageFormatProperties.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkExternalImageFormatProperties	callocStack(MemoryStack stack)	Deprecated.
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()	a VkExternalMemoryProperties structure specifying various capabilities of the external handle type when used with the specified image creation parameters.
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkExternalImageFormatProperties.Buffer instance allocated on the specified MemoryStack.
static VkExternalImageFormatProperties	malloc(MemoryStack stack)	Returns a new VkExternalImageFormatProperties instance allocated on the specified MemoryStack.
static VkExternalImageFormatProperties	mallocStack()	Deprecated.
static VkExternalImageFormatProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkExternalImageFormatProperties.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkExternalImageFormatProperties	mallocStack(MemoryStack stack)	Deprecated.
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()	NULL or a pointer to a structure extending this structure.
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()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkExternalImageFormatProperties	sType(int value)	Sets the specified value to the sType() field.
VkExternalImageFormatProperties	sType$Default()	Sets the STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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 Details

VkExternalImageFormatProperties

public VkExternalImageFormatProperties(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkExternalImageFormatProperties>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

externalMemoryProperties

public VkExternalMemoryProperties externalMemoryProperties()

a VkExternalMemoryProperties structure specifying various capabilities of the external handle type when used with the specified image creation parameters.

sType

public VkExternalImageFormatProperties sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExternalImageFormatProperties sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES 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

@Deprecated
public static VkExternalImageFormatProperties mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkExternalImageFormatProperties callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkExternalImageFormatProperties mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkExternalImageFormatProperties callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkExternalImageFormatProperties.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkExternalImageFormatProperties.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkExternalImageFormatProperties.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkExternalImageFormatProperties.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkExternalImageFormatProperties malloc(MemoryStack stack)

Returns a new VkExternalImageFormatProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkExternalImageFormatProperties calloc(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

malloc

public static VkExternalImageFormatProperties.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkExternalImageFormatProperties.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkExternalImageFormatProperties.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkExternalImageFormatProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

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.