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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkVideoBeginCodingInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of decode starts.
Valid Usage
- VkVideoBeginCodingInfoKHR::referenceSlotCount must not exceed the value specified in VkVideoSessionCreateInfoKHR::maxReferencePicturesSlotsCount when creating the video session object that is being provided in videoSession
- If videoSessionParameters is not NULL_HANDLE, it must have been created using videoSession as a parent object
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_VIDEO_BEGIN_CODING_INFO_KHR
- pNext must be NULL
- flags must be 0
- codecQualityPreset must be a valid combination of VkVideoCodingQualityPresetFlagBitsKHR values
- codecQualityPreset must not be 0
- videoSession must be a valid VkVideoSessionKHR handle
- If videoSessionParameters is not NULL_HANDLE, videoSessionParameters must be a valid VkVideoSessionParametersKHR handle
- If referenceSlotCount is not 0, pReferenceSlots must be a valid pointer to an array of referenceSlotCount valid VkVideoReferenceSlotKHR structures
- If videoSessionParameters is a valid handle, it must have been created, allocated, or retrieved from videoSession
- Both of videoSession, and videoSessionParameters that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice
See Also

VkVideoReferenceSlotKHR, CmdBeginVideoCodingKHR

Layout
```
 struct VkVideoBeginCodingInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkVideoBeginCodingFlagsKHR flags();
     VkVideoCodingQualityPresetFlagsKHR codecQualityPreset();
     VkVideoSessionKHR videoSession();
     VkVideoSessionParametersKHR videoSessionParameters();
     uint32_t referenceSlotCount();
     VkVideoReferenceSlotKHR const * pReferenceSlots();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkVideoBeginCodingInfoKHR.Buffer
An array of VkVideoBeginCodingInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`CODECQUALITYPRESET FLAGS PNEXT PREFERENCESLOTS REFERENCESLOTCOUNT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE VIDEOSESSION VIDEOSESSIONPARAMETERS`	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
`VkVideoBeginCodingInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkVideoBeginCodingInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VkVideoBeginCodingInfoKHR`	`calloc()`	Returns a new `VkVideoBeginCodingInfoKHR` instance allocated with `memCalloc`.
`static VkVideoBeginCodingInfoKHR.Buffer`	`calloc(int capacity)`	Returns a new `VkVideoBeginCodingInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkVideoBeginCodingInfoKHR.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoBeginCodingInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkVideoBeginCodingInfoKHR`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoBeginCodingInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`codecQualityPreset()`	a bitmask of `VkVideoCodingQualityPresetFlagBitsKHR` specifying the Video Decode or Encode quality preset.
`VkVideoBeginCodingInfoKHR`	`codecQualityPreset(int value)`	Sets the specified value to the `codecQualityPreset()` field.
`static VkVideoBeginCodingInfoKHR`	`create()`	Returns a new `VkVideoBeginCodingInfoKHR` instance allocated with `BufferUtils`.
`static VkVideoBeginCodingInfoKHR.Buffer`	`create(int capacity)`	Returns a new `VkVideoBeginCodingInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkVideoBeginCodingInfoKHR`	`create(long address)`	Returns a new `VkVideoBeginCodingInfoKHR` instance for the specified memory address.
`static VkVideoBeginCodingInfoKHR.Buffer`	`create(long address, int capacity)`	Create a `VkVideoBeginCodingInfoKHR.Buffer` instance at the specified memory.
`static VkVideoBeginCodingInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkVideoBeginCodingInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	reserved for future use.
`VkVideoBeginCodingInfoKHR`	`flags(int value)`	Sets the specified value to the `flags()` field.
`static VkVideoBeginCodingInfoKHR`	`malloc()`	Returns a new `VkVideoBeginCodingInfoKHR` instance allocated with `memAlloc`.
`static VkVideoBeginCodingInfoKHR.Buffer`	`malloc(int capacity)`	Returns a new `VkVideoBeginCodingInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkVideoBeginCodingInfoKHR.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoBeginCodingInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkVideoBeginCodingInfoKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoBeginCodingInfoKHR` instance allocated on the specified `MemoryStack`.
`static int`	`ncodecQualityPreset(long struct)`	Unsafe version of `codecQualityPreset()`.
`static void`	`ncodecQualityPreset(long struct, int value)`	Unsafe version of `codecQualityPreset`.
`static int`	`nflags(long struct)`	Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)`	Unsafe version of `flags`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static VkVideoReferenceSlotKHR.Buffer`	`npReferenceSlots(long struct)`	Unsafe version of `pReferenceSlots()`.
`static void`	`npReferenceSlots(long struct, VkVideoReferenceSlotKHR.Buffer value)`	Unsafe version of `pReferenceSlots`.
`static int`	`nreferenceSlotCount(long struct)`	Unsafe version of `referenceSlotCount()`.
`static void`	`nreferenceSlotCount(long struct, int value)`	Sets the specified value to the `referenceSlotCount` field of the specified `struct`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static long`	`nvideoSession(long struct)`	Unsafe version of `videoSession()`.
`static void`	`nvideoSession(long struct, long value)`	Unsafe version of `videoSession`.
`static long`	`nvideoSessionParameters(long struct)`	Unsafe version of `videoSessionParameters()`.
`static void`	`nvideoSessionParameters(long struct, long value)`	Unsafe version of `videoSessionParameters`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkVideoBeginCodingInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkVideoReferenceSlotKHR.Buffer`	`pReferenceSlots()`	a pointer to an array of `VkVideoReferenceSlotKHR` structures specifying reference slots, used within the video command context between this `CmdBeginVideoCodingKHR` command and the `CmdEndVideoCodingKHR` commmand that follows.
`VkVideoBeginCodingInfoKHR`	`pReferenceSlots(VkVideoReferenceSlotKHR.Buffer value)`	Sets the address of the specified `VkVideoReferenceSlotKHR.Buffer` to the `pReferenceSlots()` field.
`int`	`referenceSlotCount()`	the number of reference slot entries provided in `pReferenceSlots`.
`VkVideoBeginCodingInfoKHR`	`set(int sType, long pNext, int flags, int codecQualityPreset, long videoSession, long videoSessionParameters, VkVideoReferenceSlotKHR.Buffer pReferenceSlots)`	Initializes this struct with the specified values.
`VkVideoBeginCodingInfoKHR`	`set(VkVideoBeginCodingInfoKHR src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkVideoBeginCodingInfoKHR`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkVideoBeginCodingInfoKHR`	`sType$Default()`	Sets the `STRUCTURE_TYPE_VIDEO_BEGIN_CODING_INFO_KHR` value to the `sType()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.
`long`	`videoSession()`	the video session object to be bound for the processing of the video commands.
`VkVideoBeginCodingInfoKHR`	`videoSession(long value)`	Sets the specified value to the `videoSession()` field.
`long`	`videoSessionParameters()`	`NULL_HANDLE` or a handle of a `VkVideoSessionParametersKHR` object to be used for the processing of the video commands.
`VkVideoBeginCodingInfoKHR`	`videoSessionParameters(long value)`	Sets the specified value to the `videoSessionParameters()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

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, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, FLAGS, CODECQUALITYPRESET, VIDEOSESSION, VIDEOSESSIONPARAMETERS, REFERENCESLOTCOUNT, PREFERENCESLOTS
    
    The struct member offsets.
- Constructor Detail
  - VkVideoBeginCodingInfoKHR
```
public VkVideoBeginCodingInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkVideoBeginCodingInfoKHR 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()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or a pointer to a structure extending this structure.
  - flags
```
public int flags()
```
    reserved for future use.
  - codecQualityPreset
```
public int codecQualityPreset()
```
    a bitmask of VkVideoCodingQualityPresetFlagBitsKHR specifying the Video Decode or Encode quality preset.
  - videoSession
```
public long videoSession()
```
    the video session object to be bound for the processing of the video commands.
  - videoSessionParameters
```
public long videoSessionParameters()
```
    NULL_HANDLE or a handle of a VkVideoSessionParametersKHR object to be used for the processing of the video commands. If NULL_HANDLE, then no video session parameters apply to this command buffer context.
  - referenceSlotCount
```
public int referenceSlotCount()
```
    the number of reference slot entries provided in pReferenceSlots.
  - pReferenceSlots
```
@Nullable
public VkVideoReferenceSlotKHR.Buffer pReferenceSlots()
```
    a pointer to an array of VkVideoReferenceSlotKHR structures specifying reference slots, used within the video command context between this CmdBeginVideoCodingKHR command and the CmdEndVideoCodingKHR commmand that follows. Each reference slot provides a slot index and the VkVideoPictureResourceKHR specifying the reference picture resource bound to this slot index. A slot index must not appear more than once in pReferenceSlots in a given command.
  - sType
```
public VkVideoBeginCodingInfoKHR sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkVideoBeginCodingInfoKHR sType$Default()
```
    Sets the STRUCTURE_TYPE_VIDEO_BEGIN_CODING_INFO_KHR value to the sType() field.
  - pNext
```
public VkVideoBeginCodingInfoKHR pNext(long value)
```
    Sets the specified value to the pNext() field.
  - flags
```
public VkVideoBeginCodingInfoKHR flags(int value)
```
    Sets the specified value to the flags() field.
  - codecQualityPreset
```
public VkVideoBeginCodingInfoKHR codecQualityPreset(int value)
```
    Sets the specified value to the codecQualityPreset() field.
  - videoSession
```
public VkVideoBeginCodingInfoKHR videoSession(long value)
```
    Sets the specified value to the videoSession() field.
  - videoSessionParameters
```
public VkVideoBeginCodingInfoKHR videoSessionParameters(long value)
```
    Sets the specified value to the videoSessionParameters() field.
  - pReferenceSlots
```
public VkVideoBeginCodingInfoKHR pReferenceSlots(@Nullable
                                                 VkVideoReferenceSlotKHR.Buffer value)
```
    Sets the address of the specified VkVideoReferenceSlotKHR.Buffer to the pReferenceSlots() field.
  - set
```
public VkVideoBeginCodingInfoKHR set(int sType,
                                     long pNext,
                                     int flags,
                                     int codecQualityPreset,
                                     long videoSession,
                                     long videoSessionParameters,
                                     @Nullable
                                     VkVideoReferenceSlotKHR.Buffer pReferenceSlots)
```
    Initializes this struct with the specified values.
  - set
```
public VkVideoBeginCodingInfoKHR set(VkVideoBeginCodingInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkVideoBeginCodingInfoKHR malloc()
```
    Returns a new VkVideoBeginCodingInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkVideoBeginCodingInfoKHR calloc()
```
    Returns a new VkVideoBeginCodingInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkVideoBeginCodingInfoKHR create()
```
    Returns a new VkVideoBeginCodingInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkVideoBeginCodingInfoKHR create(long address)
```
    Returns a new VkVideoBeginCodingInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkVideoBeginCodingInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkVideoBeginCodingInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkVideoBeginCodingInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkVideoBeginCodingInfoKHR.Buffer create(int capacity)
```
    Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkVideoBeginCodingInfoKHR.Buffer create(long address,
                                                      int capacity)
```
    Create a VkVideoBeginCodingInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkVideoBeginCodingInfoKHR.Buffer createSafe(long address,
                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkVideoBeginCodingInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoBeginCodingInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkVideoBeginCodingInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoBeginCodingInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkVideoBeginCodingInfoKHR.Buffer malloc(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoBeginCodingInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkVideoBeginCodingInfoKHR.Buffer calloc(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoBeginCodingInfoKHR.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().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - ncodecQualityPreset
```
public static int ncodecQualityPreset(long struct)
```
    Unsafe version of codecQualityPreset().
  - nvideoSession
```
public static long nvideoSession(long struct)
```
    Unsafe version of videoSession().
  - nvideoSessionParameters
```
public static long nvideoSessionParameters(long struct)
```
    Unsafe version of videoSessionParameters().
  - nreferenceSlotCount
```
public static int nreferenceSlotCount(long struct)
```
    Unsafe version of referenceSlotCount().
  - npReferenceSlots
```
@Nullable
public static VkVideoReferenceSlotKHR.Buffer npReferenceSlots(long struct)
```
    Unsafe version of pReferenceSlots().
  - 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.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - ncodecQualityPreset
```
public static void ncodecQualityPreset(long struct,
                                       int value)
```
    Unsafe version of codecQualityPreset.
  - nvideoSession
```
public static void nvideoSession(long struct,
                                 long value)
```
    Unsafe version of videoSession.
  - nvideoSessionParameters
```
public static void nvideoSessionParameters(long struct,
                                           long value)
```
    Unsafe version of videoSessionParameters.
  - nreferenceSlotCount
```
public static void nreferenceSlotCount(long struct,
                                       int value)
```
    Sets the specified value to the referenceSlotCount field of the specified struct.
  - npReferenceSlots
```
public static void npReferenceSlots(long struct,
                                    @Nullable
                                    VkVideoReferenceSlotKHR.Buffer value)
```
    Unsafe version of pReferenceSlots.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate

Class VkVideoBeginCodingInfoKHR

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, CODECQUALITYPRESET, VIDEOSESSION, VIDEOSESSIONPARAMETERS, REFERENCESLOTCOUNT, PREFERENCESLOTS

Constructor Detail

VkVideoBeginCodingInfoKHR

Method Detail

sizeof

sType

pNext

flags

codecQualityPreset

videoSession

videoSessionParameters

referenceSlotCount

pReferenceSlots

sType

sType$Default

pNext

flags

codecQualityPreset

videoSession

videoSessionParameters

pReferenceSlots

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nflags

ncodecQualityPreset

nvideoSession

nvideoSessionParameters

nreferenceSlotCount

npReferenceSlots

nsType

npNext

nflags

ncodecQualityPreset

nvideoSession

nvideoSessionParameters

nreferenceSlotCount

npReferenceSlots

validate