Package org.lwjgl.vulkan

Class VkBindVideoSessionMemoryInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBindVideoSessionMemoryInfoKHR>

org.lwjgl.vulkan.VkBindVideoSessionMemoryInfoKHR

All Implemented Interfaces:

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

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

Structure specifying memory bindings for a video session object.

Valid Usage

• memoryOffset must be less than the size of memory
• memorySize must be less than or equal to the size of memory minus memoryOffset

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_VIDEO_SESSION_MEMORY_INFO_KHR
• pNext must be NULL
• memory must be a valid VkDeviceMemory handle

See Also

BindVideoSessionMemoryKHR

Layout

 struct VkBindVideoSessionMemoryInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t memoryBindIndex();
     VkDeviceMemory memory();
     VkDeviceSize memoryOffset();
     VkDeviceSize memorySize();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkBindVideoSessionMemoryInfoKHR.Buffer	An array of VkBindVideoSessionMemoryInfoKHR 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	MEMORY	The struct member offsets.
static final int	MEMORYBINDINDEX	The struct member offsets.
static final int	MEMORYOFFSET	The struct member offsets.
static final int	MEMORYSIZE	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
VkBindVideoSessionMemoryInfoKHR(ByteBuffer container)	Creates a VkBindVideoSessionMemoryInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkBindVideoSessionMemoryInfoKHR	calloc()	Returns a new VkBindVideoSessionMemoryInfoKHR instance allocated with memCalloc.
static VkBindVideoSessionMemoryInfoKHR.Buffer	calloc(int capacity)	Returns a new VkBindVideoSessionMemoryInfoKHR.Buffer instance allocated with memCalloc.
static VkBindVideoSessionMemoryInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBindVideoSessionMemoryInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindVideoSessionMemoryInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBindVideoSessionMemoryInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindVideoSessionMemoryInfoKHR	create()	Returns a new VkBindVideoSessionMemoryInfoKHR instance allocated with BufferUtils.
static VkBindVideoSessionMemoryInfoKHR.Buffer	create(int capacity)	Returns a new VkBindVideoSessionMemoryInfoKHR.Buffer instance allocated with BufferUtils.
static VkBindVideoSessionMemoryInfoKHR	create(long address)	Returns a new VkBindVideoSessionMemoryInfoKHR instance for the specified memory address.
static VkBindVideoSessionMemoryInfoKHR.Buffer	create(long address, int capacity)	Create a VkBindVideoSessionMemoryInfoKHR.Buffer instance at the specified memory.
static @Nullable VkBindVideoSessionMemoryInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBindVideoSessionMemoryInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkBindVideoSessionMemoryInfoKHR	malloc()	Returns a new VkBindVideoSessionMemoryInfoKHR instance allocated with memAlloc.
static VkBindVideoSessionMemoryInfoKHR.Buffer	malloc(int capacity)	Returns a new VkBindVideoSessionMemoryInfoKHR.Buffer instance allocated with memAlloc.
static VkBindVideoSessionMemoryInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBindVideoSessionMemoryInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkBindVideoSessionMemoryInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBindVideoSessionMemoryInfoKHR instance allocated on the specified MemoryStack.
long	memory()	the allocated device memory to be bound to the video session’s memory binding with index memoryBindIndex.
VkBindVideoSessionMemoryInfoKHR	memory(long value)	Sets the specified value to the memory() field.
int	memoryBindIndex()	the memory binding index to bind memory to.
VkBindVideoSessionMemoryInfoKHR	memoryBindIndex(int value)	Sets the specified value to the memoryBindIndex() field.
long	memoryOffset()	the start offset of the region of memory which is to be bound.
VkBindVideoSessionMemoryInfoKHR	memoryOffset(long value)	Sets the specified value to the memoryOffset() field.
long	memorySize()	the size in bytes of the region of memory, starting from memoryOffset bytes, to be bound.
VkBindVideoSessionMemoryInfoKHR	memorySize(long value)	Sets the specified value to the memorySize() field.
static long	nmemory(long struct)	Unsafe version of memory().
static void	nmemory(long struct, long value)	Unsafe version of memory.
static int	nmemoryBindIndex(long struct)	Unsafe version of memoryBindIndex().
static void	nmemoryBindIndex(long struct, int value)	Unsafe version of memoryBindIndex.
static long	nmemoryOffset(long struct)	Unsafe version of memoryOffset().
static void	nmemoryOffset(long struct, long value)	Unsafe version of memoryOffset.
static long	nmemorySize(long struct)	Unsafe version of memorySize().
static void	nmemorySize(long struct, long value)	Unsafe version of memorySize.
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.
VkBindVideoSessionMemoryInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkBindVideoSessionMemoryInfoKHR	set(int sType, long pNext, int memoryBindIndex, long memory, long memoryOffset, long memorySize)	Initializes this struct with the specified values.
VkBindVideoSessionMemoryInfoKHR	set(VkBindVideoSessionMemoryInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkBindVideoSessionMemoryInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkBindVideoSessionMemoryInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_BIND_VIDEO_SESSION_MEMORY_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.

MEMORYBINDINDEX

public static final int MEMORYBINDINDEX

The struct member offsets.

MEMORY

public static final int MEMORY

The struct member offsets.

MEMORYOFFSET

public static final int MEMORYOFFSET

The struct member offsets.

MEMORYSIZE

public static final int MEMORYSIZE

The struct member offsets.

Constructor Details

VkBindVideoSessionMemoryInfoKHR

public VkBindVideoSessionMemoryInfoKHR(ByteBuffer container)

Creates a VkBindVideoSessionMemoryInfoKHR 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<VkBindVideoSessionMemoryInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

memoryBindIndex

public int memoryBindIndex()

the memory binding index to bind memory to.

memory

public long memory()

the allocated device memory to be bound to the video session’s memory binding with index memoryBindIndex.

memoryOffset

public long memoryOffset()

the start offset of the region of memory which is to be bound.

memorySize

public long memorySize()

the size in bytes of the region of memory, starting from memoryOffset bytes, to be bound.

sType

public VkBindVideoSessionMemoryInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkBindVideoSessionMemoryInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_BIND_VIDEO_SESSION_MEMORY_INFO_KHR value to the sType() field.

pNext

public VkBindVideoSessionMemoryInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

memoryBindIndex

public VkBindVideoSessionMemoryInfoKHR memoryBindIndex(int value)

Sets the specified value to the memoryBindIndex() field.

memory

public VkBindVideoSessionMemoryInfoKHR memory(long value)

Sets the specified value to the memory() field.

memoryOffset

public VkBindVideoSessionMemoryInfoKHR memoryOffset(long value)

Sets the specified value to the memoryOffset() field.

memorySize

public VkBindVideoSessionMemoryInfoKHR memorySize(long value)

Sets the specified value to the memorySize() field.

set

public VkBindVideoSessionMemoryInfoKHR set(int sType,
 long pNext,
 int memoryBindIndex,
 long memory,
 long memoryOffset,
 long memorySize)

Initializes this struct with the specified values.

set

public VkBindVideoSessionMemoryInfoKHR set(VkBindVideoSessionMemoryInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBindVideoSessionMemoryInfoKHR malloc()

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

calloc

public static VkBindVideoSessionMemoryInfoKHR calloc()

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

create

public static VkBindVideoSessionMemoryInfoKHR create()

Returns a new VkBindVideoSessionMemoryInfoKHR instance allocated with BufferUtils.

create

public static VkBindVideoSessionMemoryInfoKHR create(long address)

Returns a new VkBindVideoSessionMemoryInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkBindVideoSessionMemoryInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBindVideoSessionMemoryInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBindVideoSessionMemoryInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBindVideoSessionMemoryInfoKHR.Buffer create(int capacity)

Returns a new VkBindVideoSessionMemoryInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBindVideoSessionMemoryInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkBindVideoSessionMemoryInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmemoryBindIndex

public static int nmemoryBindIndex(long struct)

Unsafe version of memoryBindIndex().

nmemory

public static long nmemory(long struct)

Unsafe version of memory().

nmemoryOffset

public static long nmemoryOffset(long struct)

Unsafe version of memoryOffset().

nmemorySize

public static long nmemorySize(long struct)

Unsafe version of memorySize().

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.

nmemoryBindIndex

public static void nmemoryBindIndex(long struct,
 int value)

Unsafe version of memoryBindIndex.

nmemory

public static void nmemory(long struct,
 long value)

Unsafe version of memory.

nmemoryOffset

public static void nmemoryOffset(long struct,
 long value)

Unsafe version of memoryOffset.

nmemorySize

public static void nmemorySize(long struct,
 long value)

Unsafe version of memorySize.