Skip to content

Commit

Permalink
api: Align naming to standard (#6152)
Browse files Browse the repository at this point in the history
Co-authored-by: Andrew Wrobel <[email protected]>
  • Loading branch information
mgonchar and akwrobel authored Nov 27, 2023
1 parent a126c45 commit 3758f77
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions api/vpl/mfxmemory.h
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ MFX_PACK_BEGIN_STRUCT_W_PTR()
Optional extension buffer, which can be attached to mfxSurfaceHeader::ExtParam
(second parameter of mfxFrameSurfaceInterface::Export) in order to pass OCL parameters
during mfxFrameSurface1 exporting to OCL surface.
If buffer is not provided all resources will be created by VPL RT internally.
If buffer is not provided all resources will be created by oneAPI Video Processing Library (oneVPL) RT internally.
*/
typedef struct {
mfxExtBuffer Header; /*!< Extension buffer header. Header.BufferId must be equal to MFX_EXTBUFF_EXPORT_SHARING_DESC_OCL. */
Expand Down Expand Up @@ -223,7 +223,7 @@ typedef struct mfxMemoryInterface {
@param[in] surf_component Surface component type. Required for allocating new surfaces from the appropriate pool.
@param[in,out] external_surface Pointer to the mfxSurfaceXXX object describing the surface to be imported. All fields in
mfxSurfaceHeader must be set by the application. mfxSurfaceHeader::SurfaceType is
read by VPL runtime to determine which particular mfxSurfaceXXX structure is supplied.
read by oneVPL runtime to determine which particular mfxSurfaceXXX structure is supplied.
For example, if mfxSurfaceXXX::SurfaceType == MFX_SURFACE_TYPE_D3D11_TEX2D, then the handle
will be interpreted as an object of type mfxSurfaceD3D11Tex2D. The application should
set or clear other fields as specified in the corresponding structure description.
Expand All @@ -239,7 +239,7 @@ typedef struct mfxMemoryInterface {
MFX_ERR_NULL_PTR If ext_surface or imported_surface are NULL.\n
MFX_ERR_INVALID_HANDLE If the corresponding session was not initialized.\n
MFX_ERR_UNSUPPORTED If surf_component is not one of [MFX_SURFACE_COMPONENT_ENCODE, MFX_SURFACE_COMPONENT_VPP_INPUT], or if
mfxSurfaceHeader::SurfaceType is not supported by VPL runtime for this operation.\n
mfxSurfaceHeader::SurfaceType is not supported by oneVPL runtime for this operation.\n
@since This function is available since API version 2.10.
*/
Expand Down
2 changes: 1 addition & 1 deletion api/vpl/mfxvideo.h
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ mfxStatus MFX_CDECL MFXVideoENCODE_GetEncodeStat(mfxSession session, mfxEncodeSt
ctrl can be freed right after successful MFXVideoENCODE_EncodeFrameAsync (it is copied inside), but not the ext buffers attached to this ctrl.
If the ext buffers are allocated by the user, do not move, alter or delete unless surface.Data.Locked is zero.
@param[in] surface Pointer to the frame surface structure.
For surfaces allocated by VPL RT it is safe to call mfxFrameSurface1::FrameInterface->Release after successful MFXVideoENCODE_EncodeFrameAsync.
For surfaces allocated by oneAPI Video Processing Library (oneVPL) RT it is safe to call mfxFrameSurface1::FrameInterface->Release after successful MFXVideoENCODE_EncodeFrameAsync.
If it is allocated by user, do not move, alter or delete unless surface.Data.Locked is zero.
@param[out] bs Pointer to the output bitstream.
@param[out] syncp Pointer to the returned sync point associated with this operation.
Expand Down

0 comments on commit 3758f77

Please sign in to comment.