capi: Redefine object interfaces to use opaque pointer types #3537
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the C API to use opaque pointer types for all Tvg_* objects, improving encapsulation and clarity.
- Changed all
typedef struct _Tvg_Xdeclarations to pointer types (typedef struct _Tvg_X* Tvg_X) - Updated function signatures in headers and implementations to accept handles (
Tvg_X) instead of pointers-to-pointers - Adjusted example code to declare handles directly and removed unnecessary indirection
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/bindings/capi/tvgCapi.cpp | Updated all C API functions to use opaque pointer types |
| src/bindings/capi/thorvg_capi.h | Changed typedefs and function declarations for handles |
| examples/Capi.cpp | Refactored example code to use new opaque handle usage |
Comments suppressed due to low confidence (3)
examples/Capi.cpp:99
- The variables
color_stops2_getandcntare not declared in this scope. You likely meant to passcolor_stops2and the count3(or a named count variable).
tvg_gradient_set_color_stops(grad_stroke, color_stops2_get, cnt);
examples/Capi.cpp:145
- Typo in comment: "Prapare" should be "Prepare".
//Prapare a dash for the stroke
src/bindings/capi/thorvg_capi.h:444
- The doc comment above this signature still refers to
canvasas a pointer. Update parameter descriptions (@param canvas) and return-value notes to reflect thatcanvasis now an opaque handle, not a pointer-to-pointer.
TVG_API Tvg_Result tvg_swcanvas_set_target(Tvg_Canvas canvas, uint32_t* buffer, uint32_t stride, uint32_t w, uint32_t h, Tvg_Colorspace cs);
Member
Author
|
API breaks, but abstracts & simplifies the interface. Let's carefully confirm. |
bed6696 to
5838334
Compare
dc2d60a to
8220c78
Compare
9ddde24 to
dac61de
Compare
Redefined Tvg_XXX and related types as pointers e.g., typedef struct _Tvg_Canvas* Tvg_Canvas) to improve encapsulation and clarity in API usage. issue: #3116
Member
Author
Collaborator
|
what about adding a |
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.
Redefined Tvg_XXX and related types as pointers
e.g., typedef struct _Tvg_Canvas* Tvg_Canvas)
to improve encapsulation and clarity in API usage.
issue: #3116