Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoDecodeH264DpbSlotInfoKHR

extends Struct<VkVideoDecodeH264DpbSlotInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*, org.lwjgl.vulkan.video.*

Structure specifies H.264 decode DPB picture information.
Description

This structure is specified in the pNext chain of VkVideoDecodeInfoKHR::pSetupReferenceSlot, if not NULL, and the pNext chain of the elements of VkVideoDecodeInfoKHR::pReferenceSlots to specify the codec-specific reference picture information for an H.264 decode operation.

Active Reference Picture Information
  • If neither pStdReferenceInfo→flags.top_field_flag nor pStdReferenceInfo→flags.bottom_field_flag is set, then the picture is added as a frame reference to the list of active reference pictures.
  • If pStdReferenceInfo→flags.top_field_flag is set, then the picture is added as a top field reference to the list of active reference pictures.
  • If pStdReferenceInfo→flags.bottom_field_flag is set, then the picture is added as a bottom field reference to the list of active reference pictures.
  • For each added reference picture, the corresponding image subregion used is determined according to the H.264 Decode Picture Data Access section.
  • Each added reference picture is associated with the DPB slot index specified in the slotIndex member of the corresponding element of VkVideoDecodeInfoKHR::pReferenceSlots.
  • Each added reference picture is associated with the H.264 reference information provided in pStdReferenceInfo.
Note

When both the top and bottom field of an interlaced frame currently associated with a DPB slot is intended to be used as an active reference picture and both fields are stored in the same image subregion (which is the case when using VIDEO_DECODE_H264_PICTURE_LAYOUT_INTERLACED_INTERLEAVED_LINES_BIT_KHR which stores the two fields at even and odd scanlines of the same image subregion), both references have to be provided through a single VkVideoReferenceSlotInfoKHR structure that has both flags.top_field_flag and flags.bottom_field_flag set in the StdVideoDecodeH264ReferenceInfo structure pointed to by the pStdReferenceInfo member of the VkVideoDecodeH264DpbSlotInfoKHR structure included in the corresponding VkVideoReferenceSlotInfoKHR structure’s pNext chain. However, this approach can only be used when both fields are stored in the same image subregion. If that is not the case (e.g. when using VIDEO_DECODE_H264_PICTURE_LAYOUT_INTERLACED_SEPARATE_PLANES_BIT_KHR which requires separate codedOffset values for the two fields and also allows storing the two fields of a frame in separate image layers or entirely separate images), then a separate VkVideoReferenceSlotInfoKHR structure needs to be provided for referencing the two fields, each only setting one of flags.top_field_flag or flags.bottom_field_flag, and providing the appropriate video picture resource information in VkVideoReferenceSlotInfoKHR::pPictureResource.

Reconstructed Picture Information
  • If neither pStdReferenceInfo→flags.top_field_flag nor pStdReferenceInfo→flags.bottom_field_flag is set, then the picture represents a frame.
  • If pStdReferenceInfo→flags.top_field_flag is set, then the picture represents a field, specifically, the top field of the frame.
  • If pStdReferenceInfo→flags.bottom_field_flag is set, then the picture represents a field, specifically, the bottom field of the frame.
  • The image subregion used is determined according to the H.264 Decode Picture Data Access section.
  • The reconstructed picture is used to activate the DPB slot with the index specified in VkVideoDecodeInfoKHR::pSetupReferenceSlot→slotIndex.
  • The reconstructed picture is associated with the H.264 reference information provided in pStdReferenceInfo.
Std Reference Information
  • flags.top_field_flag is used to indicate whether the reference is used as top field reference;
  • flags.bottom_field_flag is used to indicate whether the reference is used as bottom field reference;
  • flags.used_for_long_term_reference is used to indicate whether the picture is marked as “used for long-term reference” as defined in section 8.2.5.1 of the ITU-T H.264 Specification;
  • flags.is_non_existing is used to indicate whether the picture is marked as “non-existing” as defined in section 8.2.5.2 of the ITU-T H.264 Specification;
  • all other members are interpreted as defined in section 8.2 of the ITU-T H.264 Specification.
Valid Usage (Implicit)

Layout


struct VkVideoDecodeH264DpbSlotInfoKHR {
    VkStructureType sType;
    void const * pNext;
    StdVideoDecodeH264ReferenceInfo const * pStdReferenceInfo;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
PSTDREFERENCEINFO

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkVideoDecodeH264DpbSlotInfoKHR(ByteBuffer container)

Creates a VkVideoDecodeH264DpbSlotInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkVideoDecodeH264DpbSlotInfoKHR
calloc()

Returns a new VkVideoDecodeH264DpbSlotInfoKHR instance allocated with memCalloc.

public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkVideoDecodeH264DpbSlotInfoKHR.Buffer instance allocated with memCalloc.

public static VkVideoDecodeH264DpbSlotInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkVideoDecodeH264DpbSlotInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkVideoDecodeH264DpbSlotInfoKHR
create()

Returns a new VkVideoDecodeH264DpbSlotInfoKHR instance allocated with BufferUtils.

public static VkVideoDecodeH264DpbSlotInfoKHR
create(long address)

Returns a new VkVideoDecodeH264DpbSlotInfoKHR instance for the specified memory address.

public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkVideoDecodeH264DpbSlotInfoKHR.Buffer instance allocated with BufferUtils.

public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkVideoDecodeH264DpbSlotInfoKHR.Buffer instance at the specified memory.

public static VkVideoDecodeH264DpbSlotInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkVideoDecodeH264DpbSlotInfoKHR
malloc()

Returns a new VkVideoDecodeH264DpbSlotInfoKHR instance allocated with memAlloc.

public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkVideoDecodeH264DpbSlotInfoKHR.Buffer instance allocated with memAlloc.

public static VkVideoDecodeH264DpbSlotInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkVideoDecodeH264DpbSlotInfoKHR instance allocated on the specified MemoryStack.

public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static StdVideoDecodeH264ReferenceInfo
npStdReferenceInfo(long struct)

Unsafe version of pStdReferenceInfo.

public static void
public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkVideoDecodeH264DpbSlotInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public StdVideoDecodeH264ReferenceInfo
pStdReferenceInfo()

a pointer to a StdVideoDecodeH264ReferenceInfo structure specifying H.264 reference information.

public VkVideoDecodeH264DpbSlotInfoKHR
public VkVideoDecodeH264DpbSlotInfoKHR
set(int sType, long pNext, StdVideoDecodeH264ReferenceInfo pStdReferenceInfo)

Initializes this struct with the specified values.

public VkVideoDecodeH264DpbSlotInfoKHR

Returns:

this struct
set
(VkVideoDecodeH264DpbSlotInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkVideoDecodeH264DpbSlotInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkVideoDecodeH264DpbSlotInfoKHR
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PSTDREFERENCEINFOback to summary
public static final int PSTDREFERENCEINFO

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkVideoDecodeH264DpbSlotInfoKHRback to summary
protected VkVideoDecodeH264DpbSlotInfoKHR(long address, ByteBuffer container)
VkVideoDecodeH264DpbSlotInfoKHRback to summary
public VkVideoDecodeH264DpbSlotInfoKHR(ByteBuffer container)

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

callocback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR calloc()

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

callocback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkVideoDecodeH264DpbSlotInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR create()

Returns a new VkVideoDecodeH264DpbSlotInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR create(long address)

Returns a new VkVideoDecodeH264DpbSlotInfoKHR instance for the specified memory address.

createback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer create(int capacity)

Returns a new VkVideoDecodeH264DpbSlotInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer create(long address, int capacity)

Create a VkVideoDecodeH264DpbSlotInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR malloc()

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

mallocback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoDecodeH264DpbSlotInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkVideoDecodeH264DpbSlotInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npStdReferenceInfoback to summary
public static StdVideoDecodeH264ReferenceInfo npStdReferenceInfo(long struct)

Unsafe version of pStdReferenceInfo.

npStdReferenceInfoback to summary
public static void npStdReferenceInfo(long struct, StdVideoDecodeH264ReferenceInfo value)

Unsafe version of pStdReferenceInfo.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkVideoDecodeH264DpbSlotInfoKHR pNext(long value)

Sets the specified value to the pNext field.

pStdReferenceInfoback to summary
public StdVideoDecodeH264ReferenceInfo pStdReferenceInfo()

a pointer to a StdVideoDecodeH264ReferenceInfo structure specifying H.264 reference information.

Annotations
@NativeType:StdVideoDecodeH264ReferenceInfo const *
pStdReferenceInfoback to summary
public VkVideoDecodeH264DpbSlotInfoKHR pStdReferenceInfo(StdVideoDecodeH264ReferenceInfo value)

Sets the address of the specified StdVideoDecodeH264ReferenceInfo to the pStdReferenceInfo field.

setback to summary
public VkVideoDecodeH264DpbSlotInfoKHR set(int sType, long pNext, StdVideoDecodeH264ReferenceInfo pStdReferenceInfo)

Initializes this struct with the specified values.

setback to summary
public VkVideoDecodeH264DpbSlotInfoKHR set(VkVideoDecodeH264DpbSlotInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoDecodeH264DpbSlotInfoKHR

the source struct

Returns:VkVideoDecodeH264DpbSlotInfoKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkVideoDecodeH264DpbSlotInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkVideoDecodeH264DpbSlotInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_DECODE_H264_DPB_SLOT_INFO_KHR value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkVideoDecodeH264DpbSlotInfoKHR.Buffer

extends StructBuffer<VkVideoDecodeH264DpbSlotInfoKHR, VkVideoDecodeH264DpbSlotInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkVideoDecodeH264DpbSlotInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoDecodeH264DpbSlotInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVideoDecodeH264DpbSlotInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkVideoDecodeH264DpbSlotInfoKHR
public long

Returns:

the value of the VkVideoDecodeH264DpbSlotInfoKHR#pNext field.
pNext
()

public VkVideoDecodeH264DpbSlotInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoDecodeH264DpbSlotInfoKHR#pNext field.

public StdVideoDecodeH264ReferenceInfo
public VkVideoDecodeH264DpbSlotInfoKHR.Buffer
protected VkVideoDecodeH264DpbSlotInfoKHR.Buffer
public int

Returns:

the value of the VkVideoDecodeH264DpbSlotInfoKHR#sType field.
sType
()

public VkVideoDecodeH264DpbSlotInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoDecodeH264DpbSlotInfoKHR#sType field.

public VkVideoDecodeH264DpbSlotInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoDecodeH264DpbSlotInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVideoDecodeH264DpbSlotInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkVideoDecodeH264DpbSlotInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkVideoDecodeH264DpbSlotInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkVideoDecodeH264DpbSlotInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkVideoDecodeH264DpbSlotInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkVideoDecodeH264DpbSlotInfoKHR#pNext field.

pStdReferenceInfoback to summary
public StdVideoDecodeH264ReferenceInfo pStdReferenceInfo()
Returns:StdVideoDecodeH264ReferenceInfo

a StdVideoDecodeH264ReferenceInfo view of the struct pointed to by the VkVideoDecodeH264DpbSlotInfoKHR#pStdReferenceInfo field.

Annotations
@NativeType:StdVideoDecodeH264ReferenceInfo const *
pStdReferenceInfoback to summary
public VkVideoDecodeH264DpbSlotInfoKHR.Buffer pStdReferenceInfo(StdVideoDecodeH264ReferenceInfo value)

Sets the address of the specified StdVideoDecodeH264ReferenceInfo to the VkVideoDecodeH264DpbSlotInfoKHR#pStdReferenceInfo field.

selfback to summary
protected VkVideoDecodeH264DpbSlotInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkVideoDecodeH264DpbSlotInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkVideoDecodeH264DpbSlotInfoKHR.Buffer sType(int value)

Sets the specified value to the VkVideoDecodeH264DpbSlotInfoKHR#sType field.

sType$Defaultback to summary
public VkVideoDecodeH264DpbSlotInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_DECODE_H264_DPB_SLOT_INFO_KHR value to the VkVideoDecodeH264DpbSlotInfoKHR#sType field.