Package org.lwjgl.vulkan

Class VkPhysicalDeviceVideoFormatInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceVideoFormatInfoKHR>

org.lwjgl.vulkan.VkPhysicalDeviceVideoFormatInfoKHR

All Implemented Interfaces:

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

public class VkPhysicalDeviceVideoFormatInfoKHR
extends org.lwjgl.system.Struct<VkPhysicalDeviceVideoFormatInfoKHR>
implements org.lwjgl.system.NativeResource

Structure specifying the codec video format.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_VIDEO_FORMAT_INFO_KHR
• pNext must be NULL or a pointer to a valid instance of VkVideoProfileListInfoKHR
• The sType value of each struct in the pNext chain must be unique
• imageUsage must be a valid combination of VkImageUsageFlagBits values
• imageUsage must not be 0

See Also

GetPhysicalDeviceVideoFormatPropertiesKHR

Layout

 struct VkPhysicalDeviceVideoFormatInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkImageUsageFlags imageUsage();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceVideoFormatInfoKHR.Buffer	An array of VkPhysicalDeviceVideoFormatInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceVideoFormatInfoKHR	calloc()	Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with memCalloc.
static VkPhysicalDeviceVideoFormatInfoKHR.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceVideoFormatInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceVideoFormatInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceVideoFormatInfoKHR	create()	Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with BufferUtils.
static VkPhysicalDeviceVideoFormatInfoKHR.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceVideoFormatInfoKHR	create(long address)	Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance for the specified memory address.
static VkPhysicalDeviceVideoFormatInfoKHR.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceVideoFormatInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceVideoFormatInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageUsage()	a bitmask of VkImageUsageFlagBits specifying the intended usage of the video images.
VkPhysicalDeviceVideoFormatInfoKHR	imageUsage(int value)	Sets the specified value to the imageUsage() field.
static VkPhysicalDeviceVideoFormatInfoKHR	malloc()	Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with memAlloc.
static VkPhysicalDeviceVideoFormatInfoKHR.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceVideoFormatInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceVideoFormatInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated on the specified MemoryStack.
static int	nimageUsage(long struct)	Unsafe version of imageUsage().
static void	nimageUsage(long struct, int value)	Unsafe version of imageUsage.
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.
VkPhysicalDeviceVideoFormatInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceVideoFormatInfoKHR	pNext(VkVideoProfileListInfoKHR value)	Prepends the specified VkVideoProfileListInfoKHR value to the pNext chain.
VkPhysicalDeviceVideoFormatInfoKHR	set(int sType, long pNext, int imageUsage)	Initializes this struct with the specified values.
VkPhysicalDeviceVideoFormatInfoKHR	set(VkPhysicalDeviceVideoFormatInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceVideoFormatInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceVideoFormatInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_VIDEO_FORMAT_INFO_KHR value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

IMAGEUSAGE

public static final int IMAGEUSAGE

The struct member offsets.

Constructor Details

VkPhysicalDeviceVideoFormatInfoKHR

public VkPhysicalDeviceVideoFormatInfoKHR(ByteBuffer container)

Creates a VkPhysicalDeviceVideoFormatInfoKHR 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPhysicalDeviceVideoFormatInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

imageUsage

public int imageUsage()

a bitmask of VkImageUsageFlagBits specifying the intended usage of the video images.

sType

public VkPhysicalDeviceVideoFormatInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceVideoFormatInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_VIDEO_FORMAT_INFO_KHR value to the sType() field.

pNext

public VkPhysicalDeviceVideoFormatInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkPhysicalDeviceVideoFormatInfoKHR pNext(VkVideoProfileListInfoKHR value)

Prepends the specified VkVideoProfileListInfoKHR value to the pNext chain.

imageUsage

public VkPhysicalDeviceVideoFormatInfoKHR imageUsage(int value)

Sets the specified value to the imageUsage() field.

set

public VkPhysicalDeviceVideoFormatInfoKHR set(int sType,
 long pNext,
 int imageUsage)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceVideoFormatInfoKHR set(VkPhysicalDeviceVideoFormatInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceVideoFormatInfoKHR malloc()

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkPhysicalDeviceVideoFormatInfoKHR calloc()

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkPhysicalDeviceVideoFormatInfoKHR create()

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with BufferUtils.

create

public static VkPhysicalDeviceVideoFormatInfoKHR create(long address)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceVideoFormatInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceVideoFormatInfoKHR.Buffer malloc(int capacity)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceVideoFormatInfoKHR.Buffer calloc(int capacity)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceVideoFormatInfoKHR.Buffer create(int capacity)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceVideoFormatInfoKHR.Buffer create(long address,
 int capacity)

Create a VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkPhysicalDeviceVideoFormatInfoKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceVideoFormatInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceVideoFormatInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPhysicalDeviceVideoFormatInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceVideoFormatInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR.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().

nimageUsage

public static int nimageUsage(long struct)

Unsafe version of imageUsage().

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.

nimageUsage

public static void nimageUsage(long struct,
 int value)

Unsafe version of imageUsage.