Describe the main API types in the programmers guide - #263
Closed
kpchoi wants to merge 1 commit into
Closed
Conversation
Signed-off-by: KP Choi <kp5.choi@samsung.com>
kpchoi
force-pushed
the
docs_common_types
branch
from
August 8, 2026 05:23
988ca8a to
af03f51
Compare
Collaborator
Author
|
Folded into #262, which covers the README and programmers guide updates together. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The "Common types" section of the programmers guide listed four types and left out the ones a reader meets first, including the instance handles
oapve_tandoapvd_t.It now groups the types a caller works with and says what each is for:
oapve_t,oapvd_t,oapvm_t) with their create and delete functions, what state each holds, and the note that an instance is not internally serialized, so one instance per encoding or decoding threadoapve_cdesc_t,oapvd_cdesc_t,oapvm_cdesc_t), which configure an instance at create timeoapve_param_ton its own, since it is the encoder setting structure rather than a descriptor, noting that it starts fromoapve_param_default()and that most of it can be changed per frame at run time withoapve_config()oapv_imgb_t,oapv_bitb_tincluding thebsizeversusssizedistinction,oapv_frm_t/oapv_frms_twith thepbu_typevalues and the role ofgroup_id)oapve_stat_t/oapvd_stat_t,oapv_au_info_t,oapv_frm_info_t,oapv_tile_pos_t,oapvm_payload_t)Every description was checked against the declarations in
oapv.h. Documentation only; no code change.