Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoDecodeH264PictureInfoKHR

extends Struct<VkVideoDecodeH264PictureInfoKHR>
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 picture parameters when decoding a picture.
Description

This structure is specified in the pNext chain of the VkVideoDecodeInfoKHR structure passed to CmdDecodeVideoKHR to specify the codec-specific picture information for an H.264 decode operation.

Decode Output Picture Information
  • If pStdPictureInfo→flags.field_pic_flag is not set, then the picture represents a frame.
  • If pStdPictureInfo→flags.field_pic_flag is set, then the picture represents a field. Specifically:
    • If pStdPictureInfo→flags.bottom_field_flag is not set, then the picture represents the top field of the frame.
    • If pStdPictureInfo→flags.bottom_field_flag is set, then the picture represents the bottom field of the frame.
  • The image subregion used is determined according to the H.264 Decode Picture Data Access section.
  • The decode output picture is associated with the H.264 picture information provided in pStdPictureInfo.
Std Picture Information
  • reserved1 and reserved2 are used only for padding purposes and are otherwise ignored;
  • flags.is_intra as defined in section 3.73 of the ITU-T H.264 Specification;
  • flags.is_reference as defined in section 3.136 of the ITU-T H.264 Specification;
  • flags.complementary_field_pair as defined in section 3.35 of the ITU-T H.264 Specification;
  • seq_parameter_set_id and pic_parameter_set_id are used to identify the active parameter sets, as described below;
  • all other members are interpreted as defined in section 7.4.3 of the ITU-T H.264 Specification.
Active Parameter Sets
  • The active SPS is the SPS identified by the key specified in StdVideoDecodeH264PictureInfo::seq_parameter_set_id.
  • The active PPS is the PPS identified by the key specified by the pair constructed from StdVideoDecodeH264PictureInfo::seq_parameter_set_id and StdVideoDecodeH264PictureInfo::pic_parameter_set_id.
Valid Usage (Implicit)

Layout


struct VkVideoDecodeH264PictureInfoKHR {
    VkStructureType sType;
    void const * pNext;
    StdVideoDecodeH264PictureInfo const * pStdPictureInfo;
    uint32_t sliceCount;
    uint32_t const * pSliceOffsets;
}

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
PSLICEOFFSETS

The struct member offsets.

public static final int
PSTDPICTUREINFO

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SLICECOUNT

The struct member offsets.

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
VkVideoDecodeH264PictureInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoDecodeH264PictureInfoKHR
calloc()

Returns a new VkVideoDecodeH264PictureInfoKHR instance allocated with memCalloc.

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

Returns a new VkVideoDecodeH264PictureInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkVideoDecodeH264PictureInfoKHR
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 VkVideoDecodeH264PictureInfoKHR
create()

Returns a new VkVideoDecodeH264PictureInfoKHR instance allocated with BufferUtils.

public static VkVideoDecodeH264PictureInfoKHR
create(long address)

Returns a new VkVideoDecodeH264PictureInfoKHR instance for the specified memory address.

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

Returns a new VkVideoDecodeH264PictureInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoDecodeH264PictureInfoKHR.Buffer instance at the specified memory.

public static VkVideoDecodeH264PictureInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkVideoDecodeH264PictureInfoKHR
malloc()

Returns a new VkVideoDecodeH264PictureInfoKHR instance allocated with memAlloc.

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

Returns a new VkVideoDecodeH264PictureInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoDecodeH264PictureInfoKHR instance allocated on the specified MemoryStack.

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

Returns a new VkVideoDecodeH264PictureInfoKHR.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 IntBuffer
npSliceOffsets(long struct)

Unsafe version of pSliceOffsets.

public static void
npSliceOffsets(long struct, IntBuffer value)

Unsafe version of pSliceOffsets.

public static StdVideoDecodeH264PictureInfo
npStdPictureInfo(long struct)

Unsafe version of pStdPictureInfo.

public static void
npStdPictureInfo(long struct, StdVideoDecodeH264PictureInfo value)

Unsafe version of pStdPictureInfo.

public static int
nsliceCount(long struct)

Unsafe version of sliceCount.

public static void
nsliceCount(long struct, int value)

Sets the specified value to the sliceCount field of the specified struct.

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 VkVideoDecodeH264PictureInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public IntBuffer
pSliceOffsets()

a pointer to an array of sliceCount offsets specifying the start offset of the slices of the picture within the video bitstream buffer range specified in VkVideoDecodeInfoKHR.

public VkVideoDecodeH264PictureInfoKHR
pSliceOffsets(IntBuffer value)

Sets the address of the specified IntBuffer to the pSliceOffsets field.

public StdVideoDecodeH264PictureInfo
pStdPictureInfo()

a pointer to a StdVideoDecodeH264PictureInfo structure specifying H.264 picture information.

public VkVideoDecodeH264PictureInfoKHR
public VkVideoDecodeH264PictureInfoKHR
set(int sType, long pNext, StdVideoDecodeH264PictureInfo pStdPictureInfo, IntBuffer pSliceOffsets)

Initializes this struct with the specified values.

public VkVideoDecodeH264PictureInfoKHR

Returns:

this struct
set
(VkVideoDecodeH264PictureInfoKHR
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
sliceCount()

the number of elements in pSliceOffsets.

public int
sType()

a VkStructureType value identifying this structure.

public VkVideoDecodeH264PictureInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkVideoDecodeH264PictureInfoKHR
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.

PSLICEOFFSETSback to summary
public static final int PSLICEOFFSETS

The struct member offsets.

PSTDPICTUREINFOback to summary
public static final int PSTDPICTUREINFO

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SLICECOUNTback to summary
public static final int SLICECOUNT

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkVideoDecodeH264PictureInfoKHRback to summary
protected VkVideoDecodeH264PictureInfoKHR(long address, ByteBuffer container)
VkVideoDecodeH264PictureInfoKHRback to summary
public VkVideoDecodeH264PictureInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoDecodeH264PictureInfoKHR calloc(MemoryStack stack)

Returns a new VkVideoDecodeH264PictureInfoKHR 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 VkVideoDecodeH264PictureInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkVideoDecodeH264PictureInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoDecodeH264PictureInfoKHR create(long address)

Returns a new VkVideoDecodeH264PictureInfoKHR instance for the specified memory address.

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

Returns a new VkVideoDecodeH264PictureInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoDecodeH264PictureInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoDecodeH264PictureInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoDecodeH264PictureInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoDecodeH264PictureInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkVideoDecodeH264PictureInfoKHR.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.

npSliceOffsetsback to summary
public static IntBuffer npSliceOffsets(long struct)

Unsafe version of pSliceOffsets.

npSliceOffsetsback to summary
public static void npSliceOffsets(long struct, IntBuffer value)

Unsafe version of pSliceOffsets.

npStdPictureInfoback to summary
public static StdVideoDecodeH264PictureInfo npStdPictureInfo(long struct)

Unsafe version of pStdPictureInfo.

npStdPictureInfoback to summary
public static void npStdPictureInfo(long struct, StdVideoDecodeH264PictureInfo value)

Unsafe version of pStdPictureInfo.

nsliceCountback to summary
public static int nsliceCount(long struct)

Unsafe version of sliceCount.

nsliceCountback to summary
public static void nsliceCount(long struct, int value)

Sets the specified value to the sliceCount field of the specified struct.

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 VkVideoDecodeH264PictureInfoKHR pNext(long value)

Sets the specified value to the pNext field.

pSliceOffsetsback to summary
public IntBuffer pSliceOffsets()

a pointer to an array of sliceCount offsets specifying the start offset of the slices of the picture within the video bitstream buffer range specified in VkVideoDecodeInfoKHR.

Annotations
@NativeType:uint32_t const *
pSliceOffsetsback to summary
public VkVideoDecodeH264PictureInfoKHR pSliceOffsets(IntBuffer value)

Sets the address of the specified IntBuffer to the pSliceOffsets field.

pStdPictureInfoback to summary
public StdVideoDecodeH264PictureInfo pStdPictureInfo()

a pointer to a StdVideoDecodeH264PictureInfo structure specifying H.264 picture information.

Annotations
@NativeType:StdVideoDecodeH264PictureInfo const *
pStdPictureInfoback to summary
public VkVideoDecodeH264PictureInfoKHR pStdPictureInfo(StdVideoDecodeH264PictureInfo value)

Sets the address of the specified StdVideoDecodeH264PictureInfo to the pStdPictureInfo field.

setback to summary
public VkVideoDecodeH264PictureInfoKHR set(int sType, long pNext, StdVideoDecodeH264PictureInfo pStdPictureInfo, IntBuffer pSliceOffsets)

Initializes this struct with the specified values.

setback to summary
public VkVideoDecodeH264PictureInfoKHR set(VkVideoDecodeH264PictureInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoDecodeH264PictureInfoKHR

the source struct

Returns:VkVideoDecodeH264PictureInfoKHR

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
sliceCountback to summary
public int sliceCount()

the number of elements in pSliceOffsets.

Annotations
@NativeType:uint32_t
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_DECODE_H264_PICTURE_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 VkVideoDecodeH264PictureInfoKHR.Buffer

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

An array of VkVideoDecodeH264PictureInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoDecodeH264PictureInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVideoDecodeH264PictureInfoKHR.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 VkVideoDecodeH264PictureInfoKHR
public long

Returns:

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

public VkVideoDecodeH264PictureInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoDecodeH264PictureInfoKHR#pNext field.

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the VkVideoDecodeH264PictureInfoKHR#pSliceOffsets field.
pSliceOffsets
()

public VkVideoDecodeH264PictureInfoKHR.Buffer
pSliceOffsets(IntBuffer value)

Sets the address of the specified IntBuffer to the VkVideoDecodeH264PictureInfoKHR#pSliceOffsets field.

public StdVideoDecodeH264PictureInfo
public VkVideoDecodeH264PictureInfoKHR.Buffer
protected VkVideoDecodeH264PictureInfoKHR.Buffer
public int

Returns:

the value of the VkVideoDecodeH264PictureInfoKHR#sliceCount field.
sliceCount
()

public int

Returns:

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

public VkVideoDecodeH264PictureInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoDecodeH264PictureInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoDecodeH264PictureInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVideoDecodeH264PictureInfoKHR.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 VkVideoDecodeH264PictureInfoKHR#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 VkVideoDecodeH264PictureInfoKHR getElementFactory()

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

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

the value of the VkVideoDecodeH264PictureInfoKHR#pNext field.

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

Sets the specified value to the VkVideoDecodeH264PictureInfoKHR#pNext field.

pSliceOffsetsback to summary
public IntBuffer pSliceOffsets()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the VkVideoDecodeH264PictureInfoKHR#pSliceOffsets field.

Annotations
@NativeType:uint32_t const *
pSliceOffsetsback to summary
public VkVideoDecodeH264PictureInfoKHR.Buffer pSliceOffsets(IntBuffer value)

Sets the address of the specified IntBuffer to the VkVideoDecodeH264PictureInfoKHR#pSliceOffsets field.

pStdPictureInfoback to summary
public StdVideoDecodeH264PictureInfo pStdPictureInfo()
Returns:StdVideoDecodeH264PictureInfo

a StdVideoDecodeH264PictureInfo view of the struct pointed to by the VkVideoDecodeH264PictureInfoKHR#pStdPictureInfo field.

Annotations
@NativeType:StdVideoDecodeH264PictureInfo const *
pStdPictureInfoback to summary
public VkVideoDecodeH264PictureInfoKHR.Buffer pStdPictureInfo(StdVideoDecodeH264PictureInfo value)

Sets the address of the specified StdVideoDecodeH264PictureInfo to the VkVideoDecodeH264PictureInfoKHR#pStdPictureInfo field.

selfback to summary
protected VkVideoDecodeH264PictureInfoKHR.Buffer self()

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

Annotations
@Override
sliceCountback to summary
public int sliceCount()
Returns:int

the value of the VkVideoDecodeH264PictureInfoKHR#sliceCount field.

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

the value of the VkVideoDecodeH264PictureInfoKHR#sType field.

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

Sets the specified value to the VkVideoDecodeH264PictureInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_DECODE_H264_PICTURE_INFO_KHR value to the VkVideoDecodeH264PictureInfoKHR#sType field.