Package org.lwjgl.vulkan

Class VkExternalImageFormatProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkExternalImageFormatProperties

All Implemented Interfaces:

Pointer

Direct Known Subclasses:

VkExternalImageFormatPropertiesKHR

public class VkExternalImageFormatProperties
extends Struct

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 – an instance of the 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	Description
static class	VkExternalImageFormatProperties.Buffer	An array of VkExternalImageFormatProperties structs.

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	EXTERNALMEMORYPROPERTIES 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, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkExternalImageFormatProperties(java.nio.ByteBuffer container)	Creates a VkExternalImageFormatProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
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 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()	Returns sizeof(struct).
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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

STYPE, PNEXT, 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class 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

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.

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.

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.