thorvg

func (Accessor) Del ¶

func (accessor Accessor) Del() error

Del deletes the given accessor object.

@param[in] accessor The accessor object to be deleted.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Accessor pointer.

@since 1.0

func (Accessor) Set ¶

func (accessor Accessor) Set(paint Paint, func_ func(paint Paint) bool) error

Set sets the paint of the accessor then iterates through its descendents.

Iterates through all descendents of the scene passed through the paint argument while calling func on each and passing the data pointer to this function. When func returns false iteration stops and the function returns.

@param[in] accessor A Tvg_Accessor pointer to the accessor object.
@param[in] paint A Tvg_Paint pointer to the scene object.
@param[in] func A function pointer to the function that will be execute for each child.
@param[in] data A void pointer to data that will be passed to the func.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Accessor, Tvg_Paint, or function pointer.

@since 1.0

func (Animation) AnimationGenSlot ¶

func (animation Animation) AnimationGenSlot(slot string) uint32

AnimationGenSlot generates a new slot from the given slot data.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[in] slot The Lottie slot data in JSON format.

@return The generated slot ID when successful, 0 otherwise.

@since 1.0

func (Animation) ApplySlot ¶

func (animation Animation) ApplySlot(id uint) error

ApplySlot applies a previously generated slot to the animation.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[in] id The ID of the slot to apply, or 0 to reset all slots.

@retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded.
@retval TVG_RESULT_INVALID_ARGUMENT When the given @p id is invalid
@retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported.

@since 1.0

func (Animation) Assign ¶

func (animation Animation) Assign(layer string, ix uint, var_ string, val float32) error

Assign updates the value of an expression variable for a specific layer.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[in] layer The name of the layer containing the variable to be updated.
@param[in] ix The property index of the variable within the layer.
@param[in] var The name of the variable to be updated.
@param[in] val The new value to assign to the variable.

@retval TVG_RESULT_INSUFFICIENT_CONDITION If the animation is not loaded.
@retval TVG_RESULT_INVALID_ARGUMENT When the given parameter is invalid.
@retval TVG_RESULT_NOT_SUPPORTED When neither the layer nor the property is found in the current animation.

@note Experimental API

func (Animation) Del ¶

func (animation Animation) Del() error

Del deletes the given Tvg_Animation object.

@param[in] animation The Tvg_Animation object to be deleted.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer.

@since 0.13

func (Animation) DelSlot ¶

func (animation Animation) DelSlot(id uint) error

DelSlot deletes a previously generated slot.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[in] id The ID of the slot to delete.

@return Tvg_Result enumeration.
@retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded or the slot ID is invalid.
@retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported.

@note This function should be paired with gen.
@see tvg_lottie_animation_gen_slot()
@since 1.0

func (Animation) GetDuration ¶

func (animation Animation) GetDuration() (float32, error)

Duration Retrieves the duration of the animation in seconds.

@param[in] animation A Tvg_Animation pointer to the animation object.
@param[in] duration The duration of the animation in seconds.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer or @p duration.

@note If the Picture is not properly configured, this function will return 0.

@since 0.13

func (Animation) GetFrame ¶

func (animation Animation) GetFrame() (float32, error)

GetFrame retrieves the current frame number of the animation.

@param[in] animation A Tvg_Animation pointer to the animation object.
@param[in] no The current frame number of the animation, between 0 and totalFrame() - 1.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer or @p no

@see tvg_animation_get_total_frame()
@see tvg_animation_set_frame()

@since 0.13

func (Animation) GetMarker ¶

func (animation Animation) GetMarker(idx uint) (string, error)

GetMarker gets the marker name by a given index.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[in] idx The index of the animation marker, starts from 0.
@param[out] name The name of marker when succeed.

@retval TVG_RESULT_INVALID_ARGUMENT In case @c nullptr is passed as the argument or @c idx is out of range.

@since 1.0

func (Animation) GetMarkersCnt ¶

func (animation Animation) GetMarkersCnt() (uint, error)

GetMarkersCnt gets the marker count of the animation.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[out] cnt The count value of the markers.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 1.0

func (Animation) GetPicture ¶

func (animation Animation) GetPicture() Picture

GetPicture retrieves a picture instance associated with this animation instance.

This function provides access to the picture instance that can be used to load animation formats, such as lot. After setting up the picture, it can be added to the designated canvas, enabling control over animation frames with this Animation instance.

@param[in] animation A Tvg_Animation pointer to the animation object.

@return A picture instance that is tied to this animation.

@warning The picture instance is owned by Animation. It should not be deleted manually.

@since 0.13

func (Animation) GetSegment ¶

func (animation Animation) GetSegment() (float32, float32, error)

GetSegment gets the current segment range information.

@param[in] animation The Tvg_Animation pointer to the animation object.
@param[out] begin segment begin frame.
@param[out] end segment end frame.

@retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded.
@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer.

@since 1.0

func (Animation) GetTotalFrame ¶

func (animation Animation) GetTotalFrame() (float32, error)

GetTotalFrame retrieves the total number of frames in the animation.

@param[in] animation A Tvg_Animation pointer to the animation object.
@param[in] cnt The total number of frames in the animation.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer or @p cnt.

@note Frame numbering starts from 0.
@note If the Picture is not properly configured, this function will return 0.

@since 0.13

func (Animation) SetFrame ¶

func (animation Animation) SetFrame(no float32) error

SetFrame Specifies the current frame in the animation.

@param[in] animation A Tvg_Animation pointer to the animation object.
@param[in] no The index of the animation frame to be displayed. The index should be less than the tvg_animation_get_total_frame().

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION if the given @p no is the same as the current frame value.
@retval TVG_RESULT_NOT_SUPPORTED The picture data does not support animations.

@note For efficiency, ThorVG ignores updates to the new frame value if the difference from the current frame value
		is less than 0.001. In such cases, it returns @c Result::InsufficientCondition.
		Values less than 0.001 may be disregarded and may not be accurately retained by the Animation.
@see tvg_animation_get_total_frame()

@since 0.13

func (Animation) SetMarker ¶

func (animation Animation) SetMarker(marker string) error

SetMarker specifies a segment by marker.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[in] marker The name of the segment marker.

@retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded.
@retval TVG_RESULT_INVALID_ARGUMENT When the given @p marker is invalid.
@retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported.

@since 1.0

func (Animation) SetQuality ¶

func (animation Animation) SetQuality(value uint) error

SetQuality sets the quality level for Lottie effects.

This function controls the rendering quality of effects like blur, shadows, etc. Lower values prioritize performance while higher values prioritize quality.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[in] value The quality level (0-100). 0 represents lowest quality/best performance,
							100 represents highest quality/lowest performance, default is 50.

@retval TVG_RESULT_INSUFFICIENT_CONDITION If the animation is not loaded.
@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer.

@note This option is used as a hint; its behavior heavily depends on the render backend.

@since 1.0

func (Animation) SetSegment ¶

func (animation Animation) SetSegment(begin float32, end float32) error

SetSegment specifies the playback segment of the animation.

The set segment is designated as the play area of the animation. This is useful for playing a specific segment within the entire animation. After setting, the number of animation frames and the playback time are calculated by mapping the playback segment as the entire range.

@param[in] animation The Tvg_Animation pointer to the animation object.
@param[in] begin segment begin frame.
@param[in] end segment end frame.

@retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded.
@retval TVG_RESULT_INVALID_ARGUMENT If the @p begin is higher than @p end.

@note Animation allows a range from 0.0 to the total frame. @p end should not be higher than @p begin.
@note If a marker has been specified, its range will be disregarded.

@see tvg_lottie_animation_set_marker()
@see tvg_animation_get_total_frame()

@since 1.0

func (Animation) Tween ¶

func (animation Animation) Tween(from float32, to float32, progress float32) error

Tween interpolates between two frames over a specified duration.

This method performs tweening, a process of generating intermediate frame between @p from and @p to based on the given @p progress.

@param[in] animation The Tvg_Animation pointer to the Lottie animation object.
@param[in] from The start frame number of the interpolation.
@param[in] to The end frame number of the interpolation.
@param[in] progress The current progress of the interpolation (range: 0.0 to 1.0).

@retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded.

@since 1.0

func (Canvas) Add ¶

func (canvas Canvas) Add(paint Paint) error

Add inserts a drawing element into the canvas using a Tvg_Paint object.

@param[in] canvas The Tvg_Canvas object managing the @p paint.
@param[in] paint The Tvg_Paint object to be drawn.

Only the paints added into the canvas will be drawing targets. They are retained by the canvas until you call tvg_canvas_remove()

@return Tvg_Result return values:
@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION An internal error.

@note The rendering order of the paints is the same as the order as they were added. Consider sorting the paints before adding them if you intend to use layering.
@see tvg_canvas_insert()
@see tvg_canvas_remove()

func (Canvas) Buffer ¶

func (canvas Canvas) Buffer() []byte

Buffer returns the buffer target of a software canvas.

The buffer remains the canvas's target, so its contents should not be altered.

If the canvas is not a software canvas, nil will be returned. If the canvas is a software canvas but has never has a target set, nil will be returned.

func (*Canvas) Destroy ¶

func (canvas *Canvas) Destroy() error

Destroy clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas object itself.

@param[in] canvas The Tvg_Canvas object to be destroyed.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer to the Tvg_Canvas object is passed.

func (Canvas) Draw ¶

func (canvas Canvas) Draw(clear_ bool) error

Draw requests the canvas to render the Paint objects.

@param[in] canvas The Tvg_Canvas object containing elements to be drawn.
@param[in] clear If @c true, clears the target buffer to zero before drawing.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Canvas pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION The canvas is not properly prepared.
					This may occur if the canvas target has not been set or if the update is called during drawing.
					without calling tvg_canvas_sync() in between.

  @note Clearing the buffer is unnecessary if the canvas will be fully covered

	with opaque content. Skipping the clear can improve performance.

  @note Drawing may be performed asynchronously if the thread count is greater than zero.

	To ensure the drawing process is complete, call sync() afterwards.

  @note If the canvas has not been updated prior to tvg_canvas_draw(), it may implicitly perform tvg_canvas_update()

  @see tvg_canvas_sync()
  @see tvg_canvas_update()

func (*Canvas) GlSetTarget ¶

func (canvas *Canvas) GlSetTarget(
	display unsafe.Pointer, surface unsafe.Pointer, context unsafe.Pointer, id int,
	width uint, height uint, colorSpace ColorSpace,
) error

GlSetTarget sets the drawing target for rasterization.

This function specifies the drawing target where the rasterization will occur. It can target a specific framebuffer object (FBO) or the main surface.

@param[in] display The platform-specific display handle (EGLDisplay for EGL). Set @c nullptr for other systems.
@param[in] surface The platform-specific surface handle (EGLSurface for EGL, HDC for WGL). Set @c nullptr for other systems.
@param[in] context The OpenGL context to be used for rendering on this canvas.
@param[in] id The GL target ID, usually indicating the FBO ID. A value of @c 0 specifies the main surface.
@param[in] w The width (in pixels) of the raster image.
@param[in] h The height (in pixels) of the raster image.
@param[in] cs Specifies how the pixel values should be interpreted. Currently, it only allows @c TVG_COLORSPACE_ABGR8888S as @c GL_RGBA8.

@note If @p display and @p surface are not provided, the ThorVG GL engine assumes that the appropriate OpenGL context is already current and will not attempt to bind a new one.

@retval TVG_RESULT_INSUFFICIENT_CONDITION If the canvas is currently rendering.
Ensure that @ref tvg_canvas_sync() has been called before setting a new target.

@retval TVG_RESULT_NOT_SUPPORTED In case the gl engine is not supported.

@see tvg_canvas_sync()

@since 1.0

func (Canvas) Insert ¶

func (canvas Canvas) Insert(target Paint, paint Paint) error

Insert adds a paint object to the root scene.

This function appends a paint object to root scene of the canvas. If the optional @p at is provided, the new paint object will be inserted immediately before the specified paint object in the root scene. If @p at is @c nullptr, the paint object will be added to the end of the root scene.

@param[in] canvas The Tvg_Canvas object managing the @p paint.
@param[in] target A pointer to the Paint object to be added into the root scene.
									This parameter must not be @c nullptr.
@param[in] at A pointer to an existing Paint object in the root scene before which
							the new paint object will be added. If @c nullptr, the new
							paint object is added to the end of the root scene. The default is @c nullptr.

@note The ownership of the @p paint object is transferred to the canvas upon addition.
@note The rendering order of the paints is the same as the order as they were added. Consider sorting the paints before adding them if you intend to use layering.

@see tvg_canvas_add()
@see tvg_canvas_remove()
@see tvg_canvas_remove()
@since 1.0

func (Canvas) Remove ¶

func (canvas Canvas) Remove(paint Paint) error

Remove removes a paint object from the root scene.

This function removes a specified paint object from the root scene. If no paint object is specified (i.e., the default @c nullptr is used), the function performs to clear all paints from the scene.

@param[in] canvas A Tvg_Canvas object to remove the @p paint.
@param[in] paint A pointer to the Paint object to be removed from the root scene.
								If @c nullptr, remove all the paints from the root scene.

@see tvg_canvas_add()
@see tvg_canvas_insert()
@since 1.0

func (Canvas) SetViewport ¶

func (canvas Canvas) SetViewport(x int, y int, width int, height int) error

* SetViewport Sets the drawing region of the canvas.

This function defines a rectangular area of the canvas to be used for drawing operations. The specified viewport clips rendering output to the boundaries of that rectangle.

Please note that changing the viewport is only allowed at the beginning of the rendering sequence—that is, after calling tvg_canvas_sync().

@param[in] canvas The Tvg_Canvas object containing elements which were drawn.
@param[in] x The x-coordinate of the upper-left corner of the rectangle.
@param[in] y The y-coordinate of the upper-left corner of the rectangle.
@param[in] w The width of the rectangle.
@param[in] h The height of the rectangle.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Canvas pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If the canvas is not in a synced state.

@see tvg_canvas_sync()
@see tvg_swcanvas_set_target()
@see tvg_glcanvas_set_target()
@see tvg_wgcanvas_set_target()

  @warning Changing the viewport is not allowed after calling tvg_canvas_add(),

	tvg_canvas_remove(), tvg_canvas_update(), or tvg_canvas_draw().

  @note When the target is reset, the viewport will also be reset to match the target size.
  @since 0.15

func (*Canvas) SwSetTarget ¶

func (canvas *Canvas) SwSetTarget(stride uint, width uint, height uint, cs ColorSpace) error

SwSetTarget Sets the buffer used in the rasterization process and defines the used colorspace.

For optimisation reasons TVG does not allocate memory for the output buffer on its own. The buffer of a desirable size should be allocated and owned by the caller.

@param[in] canvas The Tvg_Canvas object managing the @p buffer.
@param[in] buffer A pointer to the allocated memory block of the size @p stride x @p h.
@param[in] stride The stride of the raster image - in most cases same value as @p w.
@param[in] w The width of the raster image.
@param[in] h The height of the raster image.
@param[in] cs The colorspace value defining the way the 32-bits colors should be read/written.

@retval TVG_RESULT_INVALID_ARGUMENTS An invalid canvas or buffer pointer passed or one of the @p stride, @p w or @p h being zero.
@retval TVG_RESULT_INSUFFICIENT_CONDITION if the canvas is performing rendering. Please ensure the canvas is synced.
@retval TVG_RESULT_NOT_SUPPORTED The software engine is not supported.

  @warning Do not access @p buffer during tvg_canvas_draw() - tvg_canvas_sync(). It should not be accessed while the engine is writing on it.

  @see Tvg_Colorspace

func (Canvas) Sync ¶

func (canvas Canvas) Sync() error

Sync guarantees that drawing task is finished.

@param[in] canvas The Tvg_Canvas object containing elements which were drawn.

The Canvas rendering can be performed asynchronously. To make sure that rendering is finished, the tvg_canvas_sync() must be called after the tvg_canvas_draw() regardless of threading.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Canvas pointer.

@see tvg_canvas_draw()

func (Canvas) Update ¶

func (canvas Canvas) Update(Paint) error

Update requests the canvas to update modified paint objects in preparation for rendering.

This function triggers an internal update for all paint instances that have been modified since the last update. It ensures that the canvas state is ready for accurate rendering.

  @param[in] canvas The Tvg_Canvas object to be updated.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Canvas pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION The canvas is not properly prepared.
					This may occur if the canvas target has not been set or if the update is called during drawing.
					Call tvg_canvas_sync() before trying.

@note Only paint objects that have been changed will be processed.
@note If the canvas is configured with multiple threads, the update may be performed asynchronously.

  @see tvg_canvas_sync()

func (LinearGradient) Del ¶

func (gradient LinearGradient) Del() error

Del deletes the given gradient object.

@param[in] grad The gradient object to be deleted.
@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.

func (LinearGradient) Duplicate ¶

func (gradient LinearGradient) Duplicate() LinearGradient

Duplicate duplicates the given Tvg_Gradient object. Creates a new object and sets its all properties as in the original object.

@param[in] grad The Tvg_Gradient object to be copied.
@return A copied Tvg_Gradient object if succeed, @c nullptr otherwise.

func (LinearGradient) Get ¶

func (gradient LinearGradient) Get() (float32, float32, float32, float32, error)

Get gets the linear gradient bounds. The bounds of the linear gradient are defined as a surface constrained by two parallel lines crossing the given points (@p x1, @p y1) and (@p x2, @p y2), respectively. Both lines are perpendicular to the line linking (@p x1, @p y1) and (@p x2, @p y2).

@param[in] grad The Tvg_Gradient object of which to get the bounds.
@param[out] x1 The horizontal coordinate of the first point used to determine the gradient bounds.
@param[out] y1 The vertical coordinate of the first point used to determine the gradient bounds.
@param[out] x2 The horizontal coordinate of the second point used to determine the gradient bounds.
@param[out] y2 The vertical coordinate of the second point used to determine the gradient bounds.
@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.

func (LinearGradient) GetColorStops ¶

func (gradient LinearGradient) GetColorStops() ([]ColorStop, error)

GetColorStops gets the parameters of the colors of the gradient, their position and number

The function does not allocate any memory.

@param[in] grad The Tvg_Gradient object of which to get the color information.
@param[out] color_stop An array of Tvg_Color_Stop data structure.
@param[out] cnt The size of the @p color_stop array equal to the colors number used in the gradient.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the argument.

func (LinearGradient) GetSpread ¶

func (gradient LinearGradient) GetSpread() (StrokeFill, error)

GetSpread gets the FillSpread value of the gradient object.

@param[in] grad The Tvg_Gradient object.
@param[out] spread The FillSpread value.
@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the argument.

func (LinearGradient) GetTransform ¶

func (gradient LinearGradient) GetTransform() (Matrix, error)

GetTransform gets the matrix of the affine transformation of the gradient object. In case no transformation was applied, the identity matrix is set.

@param[in] grad The Tvg_Gradient object of which to get the transformation matrix.
@param[out] m The 3x3 augmented matrix.
@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (LinearGradient) GetType ¶

func (gradient LinearGradient) GetType() (Type, error)

GetType gets the unique value of the gradient instance indicating the instance type.

@param[in] grad The Tvg_Gradient object of which to get the type value.
@param[out] type The unique type of the gradient instance type.
@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
@since 1.0

func (LinearGradient) Set ¶

func (gradient LinearGradient) Set(x1 float32, y1 float32, x2 float32, y2 float32) error

Set sets the linear gradient bounds. The bounds of the linear gradient are defined as a surface constrained by two parallel lines crossing the given points (@p x1, @p y1) and (@p x2, @p y2), respectively. Both lines are perpendicular to the line linking (@p x1, @p y1) and (@p x2, @p y2).

@param[in] grad The Tvg_Gradient object of which bounds are to be set.
@param[in] x1 The horizontal coordinate of the first point used to determine the gradient bounds.
@param[in] y1 The vertical coordinate of the first point used to determine the gradient bounds.
@param[in] x2 The horizontal coordinate of the second point used to determine the gradient bounds.
@param[in] y2 The vertical coordinate of the second point used to determine the gradient bounds.
@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.
@note In case the first and the second points are equal, an object is filled with a single color using the last color specified in the tvg_gradient_set_color_stops().
@see tvg_gradient_set_color_stops()

func (LinearGradient) SetColorStops ¶

func (gradient LinearGradient) SetColorStops(colorStops []ColorStop) error

SetColorStops Sets the parameters of the colors of the gradient and their position.

@param[in] grad The Tvg_Gradient object of which the color information is to be set.
@param[in] color_stop An array of Tvg_Color_Stop data structure.
@param[in] cnt The size of the @p color_stop array equal to the colors number used in the gradient.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.

func (LinearGradient) SetSpread ¶

func (gradient LinearGradient) SetSpread(spread StrokeFill) error

SetSpread sets the Tvg_Stroke_Fill value, which specifies how to fill the area outside the gradient bounds.

@param[in] grad The Tvg_Gradient object.
@param[in] spread The FillSpread value.
@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.

func (LinearGradient) SetTransform ¶

func (gradient LinearGradient) SetTransform(matrix Matrix) error

SetTransform sets the matrix of the affine transformation for the gradient object. The augmented matrix of the transformation is expected to be given.

@param[in] grad The Tvg_Gradient object to be transformed.
@param[in] m The 3x3 augmented matrix.
@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Picture) Duplicate ¶

func (picture Picture) Duplicate() Picture

Duplicate duplicates a Picture.

Creates a new object and sets its all properties as in the original object.

@param[in] paint The Tvg_Paint object to be copied.

@return A copied Tvg_Paint object if succeed, @c nullptr otherwise.

func (Picture) GetAABB ¶

func (paint Picture) GetAABB() (float32, float32, float32, float32, error)

GetAABB retrieves the axis-aligned bounding box (AABB) of the paint object in canvas space.

Returns the bounding box of the paint as an axis-aligned bounding box (AABB), with all relevant transformations applied. The returned values @p x, @p y, @p w, @p h, may have invalid if the operation fails. Thus, please check the retval.

This bounding box can be used to determine the actual rendered area of the object on the canvas, for purposes such as hit-testing, culling, or layout calculations.

@param[in] paint The Tvg_Paint object of which to get the bounds.
@param[out] x The x-coordinate of the upper-left corner of the bounding box.
@param[out] y The y-coordinate of the upper-left corner of the bounding box.
@param[out] w The width of the bounding box.
@param[out] h The height of the bounding box.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid @p paint.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If it failed to compute the bounding box (mostly due to invalid path information).

@see tvg_paint_get_obb()
@see tvg_canvas_update()

func (Picture) GetClip ¶

func (paint Picture) GetClip() (any, bool)

GetClip gets the clipper shape of the paint object.

This function returns the clipper that has been previously set to this paint object.

@return The shape object used as the clipper, or @c nullptr if no clipper is set.

@see tvg_paint_set_clip()

@since 1.0

func (Picture) GetMaskMethod ¶

func (paint Picture) GetMaskMethod(target Paint) (MaskMethod, error)

GetMaskMethod gets the masking target object and the masking method.

@param[in] paint The source object of the masking.
@param[out] target The target object of the masking.
@param[out] method The method used to mask the source object with the target.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Picture) GetOBB ¶

func (paint Picture) GetOBB() ([4]Point, error)

GetOBB retrieves the object-oriented bounding box (OBB) of the paint object in canvas space.

This function returns the bounding box of the paint, as an oriented bounding box (OBB) after transformations are applied. The returned values @p pt4 may have invalid if the operation fails. Thus, please check the retval.

This bounding box can be used to obtain the transformed bounding region in canvas space by taking the geometry's axis-aligned bounding box (AABB) in the object's local coordinate space and applying the object's transformations.

@param[in] paint The Tvg_Paint object of which to get the bounds.
@param[out] pt4 An array of four points representing the bounding box. The array size must be 4.

@retval TVG_RESULT_INVALID_ARGUMENT @p paint or @p pt4 is invalid.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If it failed to compute the bounding box (mostly due to invalid path information).

@see tvg_paint_get_aabb()
@see tvg_canvas_update()

@since 1.0

func (Picture) GetOpacity ¶

func (paint Picture) GetOpacity() (uint8, error)

GetOpacity gets the opacity of the given Tvg_Paint.

@param[in] paint The Tvg_Paint object of which to get the opacity value.
@param[out] opacity The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

func (Picture) GetOrigin ¶

func (picture Picture) GetOrigin() (float32, float32, error)

GetOrigin gets the normalized origin point of the Picture object.

This method retrieves the current origin point of the Picture, expressed in normalized coordinates relative to the picture’s bounds.

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[out] x The normalized x-coordinate of the origin (range: 0.0f to 1.0f).
@param[out] y The normalized y-coordinate of the origin (range: 0.0f to 1.0f).

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@see tvg_picture_set_origin()
@since 1.0

func (Picture) GetPaint ¶

func (picture Picture) GetPaint(id uint) (Paint, bool)

GetPaint retrieves a paint object from the Picture scene by its Unique ID.

This function searches for a paint object within the Picture scene that matches the provided @p id.

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[in] id The Unique ID of the paint object.

@return A pointer to the paint object that matches the given identifier, or @c nullptr if no matching paint object is found.

@see tvg_accessor_generate_id()
@since 1.0

func (Picture) GetParent ¶

func (paint Picture) GetParent() (any, bool)

GetParent retrieves the parent paint object.

This function returns a pointer to the parent object if the current paint belongs to one. Otherwise, it returns @c nullptr.

@param[in] paint The Tvg_Paint object of which to get the scene.

@return A pointer to the parent object if available, otherwise @c nullptr.

@see tvg_scene_add()
@see tvg_canvas_add()

@since 1.0

func (Picture) GetRef ¶

func (paint Picture) GetRef() int

GetRef retrieves the current reference count of the Tvg_Paint object.

This method provides the current reference count, allowing the user to check the shared ownership state of the Tvg_Paint object.

@param[in] paint The Tvg_Paint object to return the reference count.

@return The current reference count of the Tvg_Paint object.

@see tvg_paint_ref()
@see tvg_paint_unref()

@since 1.0

func (Picture) GetSize ¶

func (picture Picture) GetSize() (float32, float32, error)

GetSize gets the size of the loaded picture.

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[out] w A width of the image in pixels.
@param[out] h A height of the image in pixels.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

func (Picture) GetType ¶

func (paint Picture) GetType() (Type, error)

GetType gets the unique value of the paint instance indicating the instance type.

@param[in] paint The Tvg_Paint object of which to get the type value.
@param[out] type The unique type of the paint instance type.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 1.0

func (Picture) GetVisible ¶

func (paint Picture) GetVisible() bool

GetVisibile gets the current visibility status of the Paint object.

@param[in] paint The Tvg_Paint object to return the visibility status.

@return true if the object is visible and will be rendered.
				false if the object is hidden and will not be rendered.

@see tvg_paint_set_visible()

@since 1.0

func (Picture) Intersects ¶

func (paint Picture) Intersects(x int, y int, width int, height int) bool

Intersects checks whether a given region intersects the filled area of the paint.

This function determines whether the specified rectangular region—defined by (`x`, `y`, `w`, `h`)— intersects the geometric fill region of the paint object.

This is useful for hit-testing purposes, such as detecting whether a user interaction (e.g., touch or click) occurs within a painted region.

The paint must be updated in a Canvas beforehand—typically after the Canvas has been drawn and synchronized.

@param[in] paint A Tvg_Paint pointer to the shape object to be tested.
@param[in] x The x-coordinate of the top-left corner of the test region.
@param[in] y The y-coordinate of the top-left corner of the test region.
@param[in] w The width of the region to test. Must be greater than 0; defaults to 1.
@param[in] h The height of the region to test. Must be greater than 0; defaults to 1.

@return @c true if any part of the region intersects the filled area; otherwise, @c false.

@note To test a single point, set the region size to w = 1, h = 1.
@note For efficiency, an AABB (axis-aligned bounding box) test is performed internally before precise hit detection.
@note This test does not take into account the results of blending or masking.
@note This test does take into account the the hidden paints as well. @see tvg_paint_set_visible().
@since 1.0

func (Picture) Load ¶

func (picture Picture) Load(path string) error

Load Loads a picture data directly from a file.

ThorVG efficiently caches the loaded data using the specified @p path as a key. This means that loading the same file again will not result in duplicate operations; instead, ThorVG will reuse the previously loaded picture data.

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[in] path The absolute path to the image file.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer or an empty @p path.
@retval TVG_RESULT_NOT_SUPPORTED A file with an unknown extension.

func (Picture) LoadData ¶

func (picture Picture) LoadData(data []byte, mimetype string, rpath string) error

LoadData loads a picture data from a memory block of a given size.

ThorVG efficiently caches the loaded data using the specified @p data address as a key when the @p copy has @c false. This means that loading the same data again will not result in duplicate operations for the sharable @p data. Instead, ThorVG will reuse the previously loaded picture data.

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[in] data A pointer to a memory location where the content of the picture file is stored. A null-terminated string is expected for non-binary data if @p copy is @c false
@param[in] size The size in bytes of the memory occupied by the @p data.
@param[in] mimetype Mimetype or extension of data such as "jpg", "jpeg", "svg", "svg+xml", "lot", "lottie+json", "png", etc. In case an empty string or an unknown type is provided, the loaders will be tried one by one.
@param[in] rpath A resource directory path, if the @p data needs to access any external resources.
@param[in] copy If @c true the data are copied into the engine local buffer, otherwise they are not.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument or the @p size is zero or less.
@retval TVG_RESULT_NOT_SUPPORTED A file with an unknown extension.

@warning: It's the user responsibility to release the @p data memory if the @p copy is @c true.

func (Picture) LoadDataText ¶

func (picture Picture) LoadDataText(text string, mimetype string, rpath string) error

LoadDataText loads a picture data from a string. The string should be a text based image format, such as svg.

ThorVG efficiently caches the loaded data using the specified @p data address as a key when the @p copy has @c false. This means that loading the same data again will not result in duplicate operations for the sharable @p data. Instead, ThorVG will reuse the previously loaded picture data.

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[in] data A pointer to a memory location where the content of the picture file is stored. A null-terminated string is expected for non-binary data if @p copy is @c false
@param[in] size The size in bytes of the memory occupied by the @p data.
@param[in] mimetype Mimetype or extension of data such as "jpg", "jpeg", "svg", "svg+xml", "lot", "lottie+json", "png", etc. In case an empty string or an unknown type is provided, the loaders will be tried one by one.
@param[in] rpath A resource directory path, if the @p data needs to access any external resources.
@param[in] copy If @c true the data are copied into the engine local buffer, otherwise they are not.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument or the @p size is zero or less.
@retval TVG_RESULT_NOT_SUPPORTED A file with an unknown extension.

@warning: It's the user responsibility to release the @p data memory if the @p copy is @c true.

func (Picture) LoadRaw ¶

func (picture Picture) LoadRaw(data []byte, width uint, height uint, colorSpace ColorSpace) error

LoadRaw loads raw image data in a specific format from a memory block of the given size.

ThorVG efficiently caches the loaded data, using the provided @p data address as a key when @p copy is set to @c false. This allows ThorVG to avoid redundant operations by reusing the previously loaded picture data for the same sharable @p data, rather than duplicating the load process.

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[in] data A pointer to the memory block where the raw image data is stored.
@param[in] w The width of the image in pixels.
@param[in] h The height of the image in pixels.
@param[in] cs Specifies how the 32-bit color values should be interpreted (read/write).
@param[in] copy If @c true, the data is copied into the engine's local buffer. If @c false, the data is not copied.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer or no data are provided or the @p w or @p h value is zero or less.

@since 0.9

func (Picture) Ref ¶

func (paint Picture) Ref() int

Ref increments the reference count for the Tvg_Paint object.

This method increases the reference count of Tvg_Paint object, allowing shared ownership and control over its lifetime.

@param[in] paint The Tvg_Paint object to increase the reference count.

@return The updated reference count after the increment by 1.

@warning Please ensure that each call to tvg_paint_ref() is paired with a corresponding call to tvg_paint_unref() to prevent a dangling instance.

@see tvg_paint_unref()
@see tvg_paint_get_ref()

@since 1.0

func (Picture) Rel ¶

func (paint Picture) Rel() error

Rel safely releases a Tv_Paint object.

This is the counterpart to the `new()` API, and releases the given Paint object safely, handling @c nullptr and managing ownership properly.

@param[in] paint A Tvg_Paint object to release.

func (Picture) Ret_transform ¶

func (paint Picture) Ret_transform() (Matrix, error)

GetTransform gets the matrix of the affine transformation of the given Tvg_Paint object.

In case no transformation was applied, the identity matrix is returned.

@param[in] paint The Tvg_Paint object of which to get the transformation matrix.
@param[out] m The 3x3 augmented matrix.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Picture) Rotate ¶

func (paint Picture) Rotate(degree float32) error

Rotate rotates the given Tvg_Paint by the given angle.

The angle in measured clockwise from the horizontal axis. The rotational axis passes through the point on the object with zero coordinates.

@param[in] paint The Tvg_Paint object to be rotated.
@param[in] degree The value of the rotation angle in degrees.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Picture) Scale ¶

func (paint Picture) Scale(factor float32) error

Scale scales the given Tvg_Paint object by the given factor.

@param[in] paint The Tvg_Paint object to be scaled.
@param[in] factor The value of the scaling factor. The default value is 1.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Picture) SetAssetResolver ¶

func (picture Picture) SetAssetResolver(resolver PictureAssetResolver) error

SetAssetResolver sets the asset resolver callback for handling external resources (e.g., images and fonts).

This callback is invoked when an external asset reference (such as an image source or file path) is encountered in a Picture object. It allows the user to provide a custom mechanism for loading or substituting assets, such as loading from an external source or a virtual filesystem.

@param[in] resolver A user-defined function that handles the resolution of asset paths.
										The function should return @c true if the asset was successfully resolved by the user, or @c false if it was not.
@param[in] data A pointer to user-defined data that will be passed to the callback each time it is invoked.
								This can be used to maintain context or access external resources.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the @p picture argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If the @p picture is already loaded.

@note This function must be called before @ref tvg_picture_load()
			Setting the resolver after loading will have no effect on asset resolution for that asset.
@note If @c false is returned by @p resolver, ThorVG will attempt to resolve the resource using its internal resolution mechanism as a fallback.
@note To unset the resolver, pass @c nullptr as the @p resolver parameter.
@note Experimental API

@see Tvg_Picture_Asset_Resolver

func (Picture) SetBlendMethod ¶

func (paint Picture) SetBlendMethod(method BlendMethod) error

SetBlendMethod sets the blending method for the paint object.

The blending feature allows you to combine colors to create visually appealing effects, including transparency, lighting, shading, and color mixing, among others. its process involves the combination of colors or images from the source paint object with the destination (the lower layer image) using blending operations. The blending operation is determined by the chosen @p BlendMethod, which specifies how the colors or images are combined.

@param[in] paint The Tvg_Paint object of which to set the blend method.
@param[in] method The blending method to be set.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 0.15

func (Picture) SetClip ¶

func (paint Picture) SetClip(clipper Paint) error

SetClip clips the drawing region of the paint object.

This function restricts the drawing area of the paint object to the specified shape's paths.

@param[in] paint The target object of the clipping.
@param[in] clipper The shape object as the clipper.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION if the target has already belonged to another paint.
@retval TVG_RESULT_NOT_SUPPORTED If the @p clipper type is not Shape.

@see tvg_paint_get_clip()

@since 1.0

func (Picture) SetMaskMethod ¶

func (paint Picture) SetMaskMethod(target Paint, method MaskMethod) error

SetMaskMethod sets the masking target object and the masking method.

@param[in] paint The source object of the masking.
@param[in] target The target object of the masking.
@param[in] method The method used to mask the source object with the target.

@retval TVG_RESULT_INSUFFICIENT_CONDITION if the target has already belonged to another paint.

func (Picture) SetOpacity ¶

func (paint Picture) SetOpacity(opacity uint8) error

SetOpacity sets the opacity of the given Tvg_Paint.

@param[in] paint The Tvg_Paint object of which the opacity value is to be set.
@param[in] opacity The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note Setting the opacity with this API may require multiple renderings using a composition. It is recommended to avoid changing the opacity if possible.

func (Picture) SetOrigin ¶

func (picture Picture) SetOrigin(x float32, y float32) error

SetOrigin sets the normalized origin point of the Picture object.

This method defines the origin point of the Picture using normalized coordinates. Unlike a typical pivot point used only for transformations, this origin affects both the transformation behavior and the actual rendering position of the Picture.

The specified origin becomes the reference point for positioning the Picture on the canvas. For example, setting the origin to (0.5f, 0.5f) moves the visual center of the picture to the position specified by Paint::translate().

The coordinates are given in a normalized range relative to the picture's bounds: - (0.0f, 0.0f): top-left corner - (0.5f, 0.5f): center - (1.0f, 1.0f): bottom-right corner

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[in] x The normalized x-coordinate of the origin point (range: 0.0f to 1.0f).
@param[in] y The normalized y-coordinate of the origin point (range: 0.0f to 1.0f).

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note This origin directly affects how the Picture is placed on the canvas when using
			transformations such as translate(), rotate(), or scale().

@see tvg_paint_translate()
@see tvg_paint_rotate()
@see tvg_paint_scale()
@see tvg_paint_set_transform()
@see tvg_picture_get_origin()

@since 1.0

func (Picture) SetSize ¶

func (picture Picture) SetSize(width float32, height float32) error

SetSize resizes the picture content to the given width and height.

The picture content is resized while keeping the default size aspect ratio. The scaling factor is established for each of dimensions and the smaller value is applied to both of them.

@param[in] picture A Tvg_Paint pointer to the picture object.
@param[in] w A new width of the image in pixels.
@param[in] h A new height of the image in pixels.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

func (Picture) SetTransform ¶

func (paint Picture) SetTransform(matrix Matrix) error

SetTransform transforms the given Tvg_Paint using the augmented transformation matrix.

The augmented matrix of the transformation is expected to be given.

@param[in] paint The Tvg_Paint object to be transformed.
@param[in] m The 3x3 augmented matrix.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Picture) SetVisible ¶

func (paint Picture) SetVisible(visible bool) error

SetVisible sets the visibility of the Paint object.

This is useful for selectively excluding paint objects during rendering.

@param[in] paint The Tvg_Paint object to set the visibility status.
@param[in] on A boolean flag indicating visibility. The default is @c true.
						@c true, the object will be rendered by the engine.
						@c false, the object will be excluded from the drawing process.

@note An invisible object is not considered inactive—it may still participate
			in internal update processing if its prope

			rties are updated, but it will not
			be taken into account for the final drawing output. To completely deactivate
			a paint object, remove it from the canvas.

@see tvg_paint_get_visible()
@see tvg_canvas_remove()

@since 1.0

func (Picture) Translate ¶

func (paint Picture) Translate(x float32, y float32) error

Translate moves the given Tvg_Paint in a two-dimensional space.

The origin of the coordinate system is in the upper-left corner of the canvas. The horizontal and vertical axes point to the right and down, respectively.

@param[in] paint The Tvg_Paint object to be shifted.
@param[in] x The value of the horizontal shift.
@param[in] y The value of the vertical shift.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Picture) Unref ¶

func (paint Picture) Unref(free bool) int

Unref decrements the reference count for the Tvg_Paint object.

This method decreases the reference count of the Tvg_Paint object by 1. If the reference count reaches zero and the @p free flag is set to true, the instance is automatically deleted.

@param[in] paint The Tvg_Paint object to decrease the reference count.
@param[in] free Flag indicating whether to delete the Paint instance when the reference count reaches zero.

@return The updated reference count after the decrement.

@see tvg_paint_ref()
@see tvg_paint_get_ref()

@since 1.0

func (RadialGradient) Del ¶

func (gradient RadialGradient) Del() error

Del deletes the given gradient object.

@param[in] grad The gradient object to be deleted.
@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.

func (RadialGradient) Duplicate ¶

func (gradient RadialGradient) Duplicate() RadialGradient

Duplicate duplicates the given Tvg_Gradient object. Creates a new object and sets its all properties as in the original object.

@param[in] grad The Tvg_Gradient object to be copied.
@return A copied Tvg_Gradient object if succeed, @c nullptr otherwise.

func (RadialGradient) GetColorStops ¶

func (gradient RadialGradient) GetColorStops() ([]ColorStop, error)

GetColorStops gets the parameters of the colors of the gradient, their position and number

The function does not allocate any memory.

@param[in] grad The Tvg_Gradient object of which to get the color information.
@param[out] color_stop An array of Tvg_Color_Stop data structure.
@param[out] cnt The size of the @p color_stop array equal to the colors number used in the gradient.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the argument.

func (RadialGradient) GetSpread ¶

func (gradient RadialGradient) GetSpread() (StrokeFill, error)

GetSpread gets the FillSpread value of the gradient object.

@param[in] grad The Tvg_Gradient object.
@param[out] spread The FillSpread value.
@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the argument.

func (RadialGradient) GetTransform ¶

func (gradient RadialGradient) GetTransform() (Matrix, error)

GetTransform gets the matrix of the affine transformation of the gradient object. In case no transformation was applied, the identity matrix is set.

@param[in] grad The Tvg_Gradient object of which to get the transformation matrix.
@param[out] m The 3x3 augmented matrix.
@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (RadialGradient) GetType ¶

func (gradient RadialGradient) GetType() (Type, error)

GetType gets the unique value of the gradient instance indicating the instance type.

@param[in] grad The Tvg_Gradient object of which to get the type value.
@param[out] type The unique type of the gradient instance type.
@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
@since 1.0

func (RadialGradient) RadialGet ¶

func (gradient RadialGradient) RadialGet() (float32, float32, float32, float32, float32, float32, error)

RadialGet gets radial gradient attributes.

@param[in] grad The Tvg_Gradient object of which to get the gradient attributes.
@param[out] cx The horizontal coordinate of the center of the end circle.
@param[out] cy The vertical coordinate of the center of the end circle.
@param[out] r The radius of the end circle.
@param[out] fx The horizontal coordinate of the center of the start circle.
@param[out] fy The vertical coordinate of the center of the start circle.
@param[out] fr The radius of the start circle.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.

@see tvg_radial_gradient_set()

func (RadialGradient) RadialSet ¶

func (gradient RadialGradient) RadialSet(cx float32, cy float32, r float32, fx float32, fy float32, fr float32) error

RadialSet sets the radial gradient attributes.

The radial gradient is defined by the end circle with a center (@p cx, @p cy) and a radius @p r and the start circle with a center/focal point (@p fx, @p fy) and a radius @p fr. The gradient will be rendered such that the gradient stop at an offset of 100% aligns with the edge of the end circle and the stop at an offset of 0% aligns with the edge of the start circle.

@param[in] grad The Tvg_Gradient object of which bounds are to be set.
@param[in] cx The horizontal coordinate of the center of the end circle.
@param[in] cy The vertical coordinate of the center of the end circle.
@param[in] r The radius of the end circle.
@param[in] fx The horizontal coordinate of the center of the start circle.
@param[in] fy The vertical coordinate of the center of the start circle.
@param[in] fr The radius of the start circle.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer or the radius @p r or @p fr value is negative.

@note In case the radius @p r is zero, an object is filled with a single color using the last color specified in the specified in the tvg_gradient_set_color_stops().
@note In case the focal point (@p fx and @p fy) lies outside the end circle, it is projected onto the edge of the end circle.
@note If the start circle doesn't fully fit inside the end circle (after possible repositioning), the @p fr is reduced accordingly.
@note By manipulating the position and size of the focal point, a wide range of visual effects can be achieved, such as directing
			the gradient focus towards a specific edge or enhancing the depth and complexity of shading patterns.
			If a focal effect is not desired, simply align the focal point (@p fx and @p fy) with the center of the end circle (@p cx and @p cy)
			and set the radius (@p fr) to zero. This will result in a uniform gradient without any focal variations.

@see tvg_gradient_set_color_stops()

func (RadialGradient) SetColorStops ¶

func (gradient RadialGradient) SetColorStops(colorStops []ColorStop) error

SetColorStops Sets the parameters of the colors of the gradient and their position.

@param[in] grad The Tvg_Gradient object of which the color information is to be set.
@param[in] color_stop An array of Tvg_Color_Stop data structure.
@param[in] cnt The size of the @p color_stop array equal to the colors number used in the gradient.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.

func (RadialGradient) SetSpread ¶

func (gradient RadialGradient) SetSpread(spread StrokeFill) error

SetSpread sets the Tvg_Stroke_Fill value, which specifies how to fill the area outside the gradient bounds.

@param[in] grad The Tvg_Gradient object.
@param[in] spread The FillSpread value.
@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Gradient pointer.

func (RadialGradient) SetTransform ¶

func (gradient RadialGradient) SetTransform(matrix Matrix) error

SetTransform sets the matrix of the affine transformation for the gradient object. The augmented matrix of the transformation is expected to be given.

@param[in] grad The Tvg_Gradient object to be transformed.
@param[in] m The 3x3 augmented matrix.
@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (ResultError) Error ¶

func (err ResultError) Error() string

func (ResultError) Result ¶

func (err ResultError) Result() Result

func (Saver) Del ¶

func (saver Saver) Del() error

Del deletes the given Tvg_Saver object.

@param[in] saver The Tvg_Saver object to be deleted.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Saver pointer.

func (Saver) SaveAnimation ¶

func (saver Saver) SaveAnimation(animation Animation, path string, quality uint, fps uint) error

SaveAnimation Exports the given @p animation data to the given @p path

If the saver module supports any compression mechanism, it will optimize the data size. This might affect the encoding/decoding time in some cases. You can turn off the compression if you wish to optimize for speed.

@param[in] saver The Tvg_Saver object connected with the saving task.
@param[in] animation The animation to be saved with all its associated properties.
@param[in] path A path to the file, in which the animation data is to be saved.
@param[in] quality The encoded quality level. @c 0 is the minimum, @c 100 is the maximum value(recommended).
@param[in] fps The frames per second for the animation. If @c 0, the default fps is used.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION Currently saving other resources or animation has no frames.
@retval TVG_RESULT_NOT_SUPPORTED Trying to save a file with an unknown extension or in an unsupported format.
@retval TVG_RESULT_UNKNOWN Unknown if attempting to save an empty paint.

@note A higher frames per second (FPS) would result in a larger file size. It is recommended to use the default value.
@note Saving can be asynchronous if the assigned thread number is greater than zero. To guarantee the saving is done, call tvg_saver_sync() afterwards.

@see tvg_saver_sync()

@since 1.0

func (Saver) SavePaint ¶

func (saver Saver) SavePaint(paint Paint, path string, quality uint) error

SavePaint exports the given @p paint data to the given @p path

If the saver module supports any compression mechanism, it will optimize the data size. This might affect the encoding/decoding time in some cases. You can turn off the compression if you wish to optimize for speed.

@param[in] saver The Tvg_Saver object connected with the saving task.
@param[in] paint The paint to be saved with all its associated properties.
@param[in] path A path to the file, in which the paint data is to be saved.
@param[in] quality The encoded quality level. @c 0 is the minimum, @c 100 is the maximum value(recommended).

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION Currently saving other resources.
@retval TVG_RESULT_NOT_SUPPORTED Trying to save a file with an unknown extension or in an unsupported format.
@retval TVG_RESULT_UNKNOWN An empty paint is to be saved.

@note Saving can be asynchronous if the assigned thread number is greater than zero. To guarantee the saving is done, call tvg_saver_sync() afterwards.
@see tvg_saver_sync()

func (Saver) Sync ¶

func (saver Saver) Sync() error

Sync guarantees that the saving task is finished.

The behavior of the Saver module works on a sync/async basis, depending on the threading setting of the Initializer. Thus, if you wish to have a benefit of it, you must call tvg_saver_sync() after the tvg_saver_save_paint() in the proper delayed time. Otherwise, you can call tvg_saver_sync() immediately.

@param[in] saver The Tvg_Saver object connected with the saving task.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION No saving task is running.

@note The asynchronous tasking is dependent on the Saver module implementation.
@see tvg_saver_save_paint()

func (Scene) Add ¶

func (scene Scene) Add(paint Paint) error

Add adds a paint object to the scene.

This function appends a paint object to the scene.

@param[in] scene A Tvg_Paint pointer to the scene object.
@param[in] paint A pointer to the Paint object to be added into the scene.

@note The ownership of the @p paint object is transferred to the scene upon addition.

@see tvg_scene_remove()
@see tvg_scene_insert()

func (Scene) AddEffectDropShadow ¶

func (scene Scene) AddEffectDropShadow(
	r int, g int, b int, a int,
	angle float64, distance float64, sigma float64, quality int,
) error

AddEffectDropShadow applies a drop shadow effect to the scene.

This function applies a drop shadow with a Gaussian blur to the scene. The shadow can be customized using color, opacity, angle, distance, blur radius (sigma), and quality parameters.

@param[in] scene A pointer to the Tvg_Paint scene object.
@param[in] r Red channel value of the shadow color [0 - 255].
@param[in] g Green channel value of the shadow color [0 - 255].
@param[in] b Blue channel value of the shadow color [0 - 255].
@param[in] a Alpha (opacity) channel value of the shadow [0 - 255].
@param[in] angle Shadow direction in degrees [0 - 360].
@param[in] distance Distance of the shadow from the original object.
@param[in] sigma Gaussian blur sigma value for the shadow. Must be > 0.
@param[in] quality Blur quality level [0 - 100].

@since 1.0

func (Scene) AddEffectFill ¶

func (scene Scene) AddEffectFill(r int, g int, b int, a int) error

AddEffectFill applies a fill color effect to the scene.

This function overrides the scene's content colors with the specified fill color.

@param[in] scene A pointer to the Tvg_Paint scene object.
@param[in] r Red color channel value [0 - 255].
@param[in] g Green color channel value [0 - 255].
@param[in] b Blue color channel value [0 - 255].
@param[in] a Alpha (opacity) channel value [0 - 255].

@since 1.0

func (Scene) AddEffectGaussianBlur ¶

func (scene Scene) AddEffectGaussianBlur(sigma float64, direction int, border int, quality int) error

AddEffectGaussianBlur applies a Gaussian blur effect to the scene.

This function applies a Gaussian blur filter to the scene as a post-processing effect. The blur can be applied in different directions with configurable border handling and quality settings.

@param[in] scene A pointer to the Tvg_Paint scene object.
@param[in] sigma The blur radius (sigma) value. Must be greater than 0.
@param[in] direction Blur direction: 0 = both directions, 1 = horizontal only, 2 = vertical only.
@param[in] border Border handling method: 0 = duplicate, 1 = wrap.
@param[in] quality Blur quality level [0 - 100].

@since 1.0

func (Scene) AddEffectTint ¶

func (scene Scene) AddEffectTint(
	black_r int, black_g int, black_b int,
	white_r int, white_g int, white_b int,
	intensity float64,
) error

AddEffectTint applies a tint effect to the scene.

This function tints the current scene using specified black and white color values, modulated by a given intensity.

@param[in] scene A pointer to the Tvg_Paint scene object.
@param[in] black_r Red component of the black color [0 - 255].
@param[in] black_g Green component of the black color [0 - 255].
@param[in] black_b Blue component of the black color [0 - 255].
@param[in] white_r Red component of the white color [0 - 255].
@param[in] white_g Green component of the white color [0 - 255].
@param[in] white_b Blue component of the white color [0 - 255].
@param[in] intensity Tint intensity value [0 - 100].

@since 1.0

func (Scene) AddEffectTritone ¶

func (scene Scene) AddEffectTritone(
	shadow_r int, shadow_g int, shadow_b int,
	midtone_r int, midtone_g int, midtone_b int,
	highlight_r int, highlight_g int, highlight_b int,
	blend int,
) error

AddEffectTritone applies a tritone color effect to the scene.

This function applies a tritone color effect to the given scene using three sets of RGB values representing shadow, midtone, and highlight colors.

@param[in] scene A pointer to the Tvg_Paint scene object.
@param[in] shadow_r Red component of the shadow color [0 - 255].
@param[in] shadow_g Green component of the shadow color [0 - 255].
@param[in] shadow_b Blue component of the shadow color [0 - 255].
@param[in] midtone_r Red component of the midtone color [0 - 255].
@param[in] midtone_g Green component of the midtone color [0 - 255].
@param[in] midtone_b Blue component of the midtone color [0 - 255].
@param[in] highlight_r Red component of the highlight color [0 - 255].
@param[in] highlight_g Green component of the highlight color [0 - 255].
@param[in] highlight_b Blue component of the highlight color [0 - 255].
@param[in] blend A blending factor that determines the mix between the original color and the tritone colors [0 - 255].

@since 1.0

func (Scene) ClearEffects ¶

func (scene Scene) ClearEffects() error

ClearEffects resets all previously applied scene effects.

This function clears all effects that have been applied to the scene, restoring it to its original state without any post-processing.

@param[in] scene A pointer to the Tvg_Paint scene object.

@since 1.0

func (Scene) Duplicate ¶

func (scene Scene) Duplicate() Scene

Duplicate duplicates a Scene.

Creates a new object and sets its all properties as in the original object.

@param[in] paint The Tvg_Paint object to be copied.

@return A copied Tvg_Paint object if succeed, @c nullptr otherwise.

func (Scene) GetAABB ¶

func (paint Scene) GetAABB() (float32, float32, float32, float32, error)

GetAABB retrieves the axis-aligned bounding box (AABB) of the paint object in canvas space.

Returns the bounding box of the paint as an axis-aligned bounding box (AABB), with all relevant transformations applied. The returned values @p x, @p y, @p w, @p h, may have invalid if the operation fails. Thus, please check the retval.

This bounding box can be used to determine the actual rendered area of the object on the canvas, for purposes such as hit-testing, culling, or layout calculations.

@param[in] paint The Tvg_Paint object of which to get the bounds.
@param[out] x The x-coordinate of the upper-left corner of the bounding box.
@param[out] y The y-coordinate of the upper-left corner of the bounding box.
@param[out] w The width of the bounding box.
@param[out] h The height of the bounding box.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid @p paint.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If it failed to compute the bounding box (mostly due to invalid path information).

@see tvg_paint_get_obb()
@see tvg_canvas_update()

func (Scene) GetClip ¶

func (paint Scene) GetClip() (any, bool)

GetClip gets the clipper shape of the paint object.

This function returns the clipper that has been previously set to this paint object.

@return The shape object used as the clipper, or @c nullptr if no clipper is set.

@see tvg_paint_set_clip()

@since 1.0

func (Scene) GetMaskMethod ¶

func (paint Scene) GetMaskMethod(target Paint) (MaskMethod, error)

GetMaskMethod gets the masking target object and the masking method.

@param[in] paint The source object of the masking.
@param[out] target The target object of the masking.
@param[out] method The method used to mask the source object with the target.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Scene) GetOBB ¶

func (paint Scene) GetOBB() ([4]Point, error)

GetOBB retrieves the object-oriented bounding box (OBB) of the paint object in canvas space.

This function returns the bounding box of the paint, as an oriented bounding box (OBB) after transformations are applied. The returned values @p pt4 may have invalid if the operation fails. Thus, please check the retval.

This bounding box can be used to obtain the transformed bounding region in canvas space by taking the geometry's axis-aligned bounding box (AABB) in the object's local coordinate space and applying the object's transformations.

@param[in] paint The Tvg_Paint object of which to get the bounds.
@param[out] pt4 An array of four points representing the bounding box. The array size must be 4.

@retval TVG_RESULT_INVALID_ARGUMENT @p paint or @p pt4 is invalid.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If it failed to compute the bounding box (mostly due to invalid path information).

@see tvg_paint_get_aabb()
@see tvg_canvas_update()

@since 1.0

func (Scene) GetOpacity ¶

func (paint Scene) GetOpacity() (uint8, error)

GetOpacity gets the opacity of the given Tvg_Paint.

@param[in] paint The Tvg_Paint object of which to get the opacity value.
@param[out] opacity The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

func (Scene) GetParent ¶

func (paint Scene) GetParent() (any, bool)

GetParent retrieves the parent paint object.

This function returns a pointer to the parent object if the current paint belongs to one. Otherwise, it returns @c nullptr.

@param[in] paint The Tvg_Paint object of which to get the scene.

@return A pointer to the parent object if available, otherwise @c nullptr.

@see tvg_scene_add()
@see tvg_canvas_add()

@since 1.0

func (Scene) GetRef ¶

func (paint Scene) GetRef() int

GetRef retrieves the current reference count of the Tvg_Paint object.

This method provides the current reference count, allowing the user to check the shared ownership state of the Tvg_Paint object.

@param[in] paint The Tvg_Paint object to return the reference count.

@return The current reference count of the Tvg_Paint object.

@see tvg_paint_ref()
@see tvg_paint_unref()

@since 1.0

func (Scene) GetType ¶

func (paint Scene) GetType() (Type, error)

GetType gets the unique value of the paint instance indicating the instance type.

@param[in] paint The Tvg_Paint object of which to get the type value.
@param[out] type The unique type of the paint instance type.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 1.0

func (Scene) GetVisible ¶

func (paint Scene) GetVisible() bool

GetVisibile gets the current visibility status of the Paint object.

@param[in] paint The Tvg_Paint object to return the visibility status.

@return true if the object is visible and will be rendered.
				false if the object is hidden and will not be rendered.

@see tvg_paint_set_visible()

@since 1.0

func (Scene) Insert ¶

func (scene Scene) Insert(target Paint, at Paint) error

Insert adds a paint object to the scene.

This function appends a paint object to the scene. The new paint object @p target will be inserted immediately before the specified paint object @p at in the scene.

@param[in] scene A Tvg_Paint pointer to the scene object.
@param[in] target A pointer to the Paint object to be added into the scene.
@param[in] at A pointer to an existing Paint object in the scene before which
						the new paint object will be added. This parameter must not be @c nullptr.

@note The ownership of the @p paint object is transferred to the scene upon addition.

@see tvg_scene_remove()
@see tvg_scene_add()
@since 1.0

func (Scene) Intersects ¶

func (paint Scene) Intersects(x int, y int, width int, height int) bool

Intersects checks whether a given region intersects the filled area of the paint.

This function determines whether the specified rectangular region—defined by (`x`, `y`, `w`, `h`)— intersects the geometric fill region of the paint object.

This is useful for hit-testing purposes, such as detecting whether a user interaction (e.g., touch or click) occurs within a painted region.

The paint must be updated in a Canvas beforehand—typically after the Canvas has been drawn and synchronized.

@param[in] paint A Tvg_Paint pointer to the shape object to be tested.
@param[in] x The x-coordinate of the top-left corner of the test region.
@param[in] y The y-coordinate of the top-left corner of the test region.
@param[in] w The width of the region to test. Must be greater than 0; defaults to 1.
@param[in] h The height of the region to test. Must be greater than 0; defaults to 1.

@return @c true if any part of the region intersects the filled area; otherwise, @c false.

@note To test a single point, set the region size to w = 1, h = 1.
@note For efficiency, an AABB (axis-aligned bounding box) test is performed internally before precise hit detection.
@note This test does not take into account the results of blending or masking.
@note This test does take into account the the hidden paints as well. @see tvg_paint_set_visible().
@since 1.0

func (Scene) Ref ¶

func (paint Scene) Ref() int

Ref increments the reference count for the Tvg_Paint object.

This method increases the reference count of Tvg_Paint object, allowing shared ownership and control over its lifetime.

@param[in] paint The Tvg_Paint object to increase the reference count.

@return The updated reference count after the increment by 1.

@warning Please ensure that each call to tvg_paint_ref() is paired with a corresponding call to tvg_paint_unref() to prevent a dangling instance.

@see tvg_paint_unref()
@see tvg_paint_get_ref()

@since 1.0

func (Scene) Rel ¶

func (paint Scene) Rel() error

Rel safely releases a Tv_Paint object.

This is the counterpart to the `new()` API, and releases the given Paint object safely, handling @c nullptr and managing ownership properly.

@param[in] paint A Tvg_Paint object to release.

func (Scene) Remove ¶

func (scene Scene) Remove(paint Paint) error

Remove removes a paint object from the scene.

This function removes a specified paint object from the scene. If no paint object is specified (i.e., the default @c nullptr is used), the function performs to clear all paints from the scene.

@param[in] scene A Tvg_Paint pointer to the scene object.
@param[in] paint A pointer to the Paint object to be removed from the scene.
							If @c nullptr, remove all the paints from the scene.

@see tvg_scene_add()
@since 1.0

func (Scene) Ret_transform ¶

func (paint Scene) Ret_transform() (Matrix, error)

GetTransform gets the matrix of the affine transformation of the given Tvg_Paint object.

In case no transformation was applied, the identity matrix is returned.

@param[in] paint The Tvg_Paint object of which to get the transformation matrix.
@param[out] m The 3x3 augmented matrix.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Scene) Rotate ¶

func (paint Scene) Rotate(degree float32) error

Rotate rotates the given Tvg_Paint by the given angle.

The angle in measured clockwise from the horizontal axis. The rotational axis passes through the point on the object with zero coordinates.

@param[in] paint The Tvg_Paint object to be rotated.
@param[in] degree The value of the rotation angle in degrees.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Scene) Scale ¶

func (paint Scene) Scale(factor float32) error

Scale scales the given Tvg_Paint object by the given factor.

@param[in] paint The Tvg_Paint object to be scaled.
@param[in] factor The value of the scaling factor. The default value is 1.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Scene) SetBlendMethod ¶

func (paint Scene) SetBlendMethod(method BlendMethod) error

SetBlendMethod sets the blending method for the paint object.

The blending feature allows you to combine colors to create visually appealing effects, including transparency, lighting, shading, and color mixing, among others. its process involves the combination of colors or images from the source paint object with the destination (the lower layer image) using blending operations. The blending operation is determined by the chosen @p BlendMethod, which specifies how the colors or images are combined.

@param[in] paint The Tvg_Paint object of which to set the blend method.
@param[in] method The blending method to be set.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 0.15

func (Scene) SetClip ¶

func (paint Scene) SetClip(clipper Paint) error

SetClip clips the drawing region of the paint object.

This function restricts the drawing area of the paint object to the specified shape's paths.

@param[in] paint The target object of the clipping.
@param[in] clipper The shape object as the clipper.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION if the target has already belonged to another paint.
@retval TVG_RESULT_NOT_SUPPORTED If the @p clipper type is not Shape.

@see tvg_paint_get_clip()

@since 1.0

func (Scene) SetMaskMethod ¶

func (paint Scene) SetMaskMethod(target Paint, method MaskMethod) error

SetMaskMethod sets the masking target object and the masking method.

@param[in] paint The source object of the masking.
@param[in] target The target object of the masking.
@param[in] method The method used to mask the source object with the target.

@retval TVG_RESULT_INSUFFICIENT_CONDITION if the target has already belonged to another paint.

func (Scene) SetOpacity ¶

func (paint Scene) SetOpacity(opacity uint8) error

SetOpacity sets the opacity of the given Tvg_Paint.

@param[in] paint The Tvg_Paint object of which the opacity value is to be set.
@param[in] opacity The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note Setting the opacity with this API may require multiple renderings using a composition. It is recommended to avoid changing the opacity if possible.

func (Scene) SetTransform ¶

func (paint Scene) SetTransform(matrix Matrix) error

SetTransform transforms the given Tvg_Paint using the augmented transformation matrix.

The augmented matrix of the transformation is expected to be given.

@param[in] paint The Tvg_Paint object to be transformed.
@param[in] m The 3x3 augmented matrix.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Scene) SetVisible ¶

func (paint Scene) SetVisible(visible bool) error

SetVisible sets the visibility of the Paint object.

This is useful for selectively excluding paint objects during rendering.

@param[in] paint The Tvg_Paint object to set the visibility status.
@param[in] on A boolean flag indicating visibility. The default is @c true.
						@c true, the object will be rendered by the engine.
						@c false, the object will be excluded from the drawing process.

@note An invisible object is not considered inactive—it may still participate
			in internal update processing if its prope

			rties are updated, but it will not
			be taken into account for the final drawing output. To completely deactivate
			a paint object, remove it from the canvas.

@see tvg_paint_get_visible()
@see tvg_canvas_remove()

@since 1.0

func (Scene) Translate ¶

func (paint Scene) Translate(x float32, y float32) error

Translate moves the given Tvg_Paint in a two-dimensional space.

The origin of the coordinate system is in the upper-left corner of the canvas. The horizontal and vertical axes point to the right and down, respectively.

@param[in] paint The Tvg_Paint object to be shifted.
@param[in] x The value of the horizontal shift.
@param[in] y The value of the vertical shift.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Scene) Unref ¶

func (paint Scene) Unref(free bool) int

Unref decrements the reference count for the Tvg_Paint object.

This method decreases the reference count of the Tvg_Paint object by 1. If the reference count reaches zero and the @p free flag is set to true, the instance is automatically deleted.

@param[in] paint The Tvg_Paint object to decrease the reference count.
@param[in] free Flag indicating whether to delete the Paint instance when the reference count reaches zero.

@return The updated reference count after the decrement.

@see tvg_paint_ref()
@see tvg_paint_get_ref()

@since 1.0

func (Shape) AppendCircle ¶

func (shape Shape) AppendCircle(cx float32, cy float32, rx float32, ry float32, cw bool) error

AppendCircle Appends an ellipse to the path.

The position of the ellipse is specified by the coordinates of its center - @p cx and @p cy arguments.

The ellipse is treated as a new sub-path - it is not connected with the previous sub-path.

The value of the current point is set to (@p cx, @p cy - @p ry).

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] cx The horizontal coordinate of the center of the ellipse.
@param[in] cy The vertical coordinate of the center of the ellipse.
@param[in] rx The x-axis radius of the ellipse.
@param[in] ry The y-axis radius of the ellipse.
@param[in] cw Specifies the path direction: @c true for clockwise, @c false for counterclockwise.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

func (Shape) AppendPath ¶

func (shape Shape) AppendPath(cmds []PathCommand, pts []Point) error

AppendPath appends a given sub-path to the path.

The current point value is set to the last point from the sub-path. For each command from the @p cmds array, an appropriate number of points in @p pts array should be specified. If the number of points in the @p pts array is different than the number required by the @p cmds array, the shape with this sub-path will not be displayed on the screen.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] cmds The array of the commands in the sub-path.
@param[in] cmdCnt The length of the @p cmds array.
@param[in] pts The array of the two-dimensional points.
@param[in] ptsCnt The length of the @p pts array.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the argument or @p cmdCnt or @p ptsCnt equal to zero.

func (Shape) AppendRect ¶

func (shape Shape) AppendRect(x float32, y float32, w float32, h float32, rx float32, ry float32, cw bool) error

AppendRect appends a rectangle to the path.

The rectangle with rounded corners can be achieved by setting non-zero values to @p rx and @p ry arguments. The @p rx and @p ry values specify the radii of the ellipse defining the rounding of the corners.

The position of the rectangle is specified by the coordinates of its upper-left corner - @p x and @p y arguments.

The rectangle is treated as a new sub-path - it is not connected with the previous sub-path.

The value of the current point is set to (@p x + @p rx, @p y) - in case @p rx is greater than @p w/2 the current point is set to (@p x + @p w/2, @p y)

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] x The horizontal coordinate of the upper-left corner of the rectangle.
@param[in] y The vertical coordinate of the upper-left corner of the rectangle.
@param[in] w The width of the rectangle.
@param[in] h The height of the rectangle.
@param[in] rx The x-axis radius of the ellipse defining the rounded corners of the rectangle.
@param[in] ry The y-axis radius of the ellipse defining the rounded corners of the rectangle.
@param[in] cw Specifies the path direction: @c true for clockwise, @c false for counterclockwise.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note For @p rx and @p ry greater than or equal to the half of @p w and the half of @p h, respectively, the shape become an ellipse.

func (Shape) Close ¶

func (shape Shape) Close() error

Close closes the current sub-path by drawing a line from the current point to the initial point of the sub-path.

The value of the current point is set to the initial point of the closed sub-path.

@param[in] paint A Tvg_Paint pointer to the shape object.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note In case the sub-path does not contain any points, this function has no effect.

func (Shape) CubicTo ¶

func (shape Shape) CubicTo(cx1 float32, cy1 float32, cx2 float32, cy2 float32, x float32, y float32) error

CubicTo Adds new points to the sub-path, which results in drawing a cubic Bezier curve.

The Bezier curve starts at the current point and ends at the given end-point (@p x, @p y). Two control points (@p cx1, @p cy1) and (@p cx2, @p cy2) are used to determine the shape of the curve. The value of the current point is set to the given end-point.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] cx1 The horizontal coordinate of the 1st control point.
@param[in] cy1 The vertical coordinate of the 1st control point.
@param[in] cx2 The horizontal coordinate of the 2nd control point.
@param[in] cy2 The vertical coordinate of the 2nd control point.
@param[in] x The horizontal coordinate of the endpoint of the curve.
@param[in] y The vertical coordinate of the endpoint of the curve.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note In case this is the first command in the path, no data from the path are rendered.

func (Shape) Duplicate ¶

func (shape Shape) Duplicate() Shape

Duplicate duplicates a Shape.

Creates a new object and sets its all properties as in the original object.

@param[in] paint The Tvg_Paint object to be copied.

@return A copied Tvg_Paint object if succeed, @c nullptr otherwise.

func (Shape) GetAABB ¶

func (paint Shape) GetAABB() (float32, float32, float32, float32, error)

GetAABB retrieves the axis-aligned bounding box (AABB) of the paint object in canvas space.

Returns the bounding box of the paint as an axis-aligned bounding box (AABB), with all relevant transformations applied. The returned values @p x, @p y, @p w, @p h, may have invalid if the operation fails. Thus, please check the retval.

This bounding box can be used to determine the actual rendered area of the object on the canvas, for purposes such as hit-testing, culling, or layout calculations.

@param[in] paint The Tvg_Paint object of which to get the bounds.
@param[out] x The x-coordinate of the upper-left corner of the bounding box.
@param[out] y The y-coordinate of the upper-left corner of the bounding box.
@param[out] w The width of the bounding box.
@param[out] h The height of the bounding box.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid @p paint.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If it failed to compute the bounding box (mostly due to invalid path information).

@see tvg_paint_get_obb()
@see tvg_canvas_update()

func (Shape) GetClip ¶

func (paint Shape) GetClip() (any, bool)

GetClip gets the clipper shape of the paint object.

This function returns the clipper that has been previously set to this paint object.

@return The shape object used as the clipper, or @c nullptr if no clipper is set.

@see tvg_paint_set_clip()

@since 1.0

func (Shape) GetFillColor ¶

func (shape Shape) GetFillColor() (uint8, uint8, uint8, uint8, error)

GetFillColor gets the shape's solid color.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] r The red color channel value in the range [0 ~ 255]. The default value is 0.
@param[out] g The green color channel value in the range [0 ~ 255]. The default value is 0.
@param[out] b The blue color channel value in the range [0 ~ 255]. The default value is 0.
@param[out] a The alpha channel value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque. The default value is 0.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

func (Shape) GetFillRule ¶

func (shape Shape) GetFillRule() (FillRule, error)

GetFillRule retrieves the current fill rule used by the shape.

This function returns the fill rule, which determines how the interior regions of the shape are calculated when it overlaps itself.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] rule The current Tvg_Fill_Rule value of the shape.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer passed as an argument.

func (Shape) GetGradient ¶

func (shape Shape) GetGradient() (Gradient, bool, error)

GetGradient gets the gradient fill of the shape.

The function does not allocate any data.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] grad The gradient fill.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer passed as an argument.

func (Shape) GetMaskMethod ¶

func (paint Shape) GetMaskMethod(target Paint) (MaskMethod, error)

GetMaskMethod gets the masking target object and the masking method.

@param[in] paint The source object of the masking.
@param[out] target The target object of the masking.
@param[out] method The method used to mask the source object with the target.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Shape) GetOBB ¶

func (paint Shape) GetOBB() ([4]Point, error)

GetOBB retrieves the object-oriented bounding box (OBB) of the paint object in canvas space.

This function returns the bounding box of the paint, as an oriented bounding box (OBB) after transformations are applied. The returned values @p pt4 may have invalid if the operation fails. Thus, please check the retval.

This bounding box can be used to obtain the transformed bounding region in canvas space by taking the geometry's axis-aligned bounding box (AABB) in the object's local coordinate space and applying the object's transformations.

@param[in] paint The Tvg_Paint object of which to get the bounds.
@param[out] pt4 An array of four points representing the bounding box. The array size must be 4.

@retval TVG_RESULT_INVALID_ARGUMENT @p paint or @p pt4 is invalid.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If it failed to compute the bounding box (mostly due to invalid path information).

@see tvg_paint_get_aabb()
@see tvg_canvas_update()

@since 1.0

func (Shape) GetOpacity ¶

func (paint Shape) GetOpacity() (uint8, error)

GetOpacity gets the opacity of the given Tvg_Paint.

@param[in] paint The Tvg_Paint object of which to get the opacity value.
@param[out] opacity The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

func (Shape) GetParent ¶

func (paint Shape) GetParent() (any, bool)

GetParent retrieves the parent paint object.

This function returns a pointer to the parent object if the current paint belongs to one. Otherwise, it returns @c nullptr.

@param[in] paint The Tvg_Paint object of which to get the scene.

@return A pointer to the parent object if available, otherwise @c nullptr.

@see tvg_scene_add()
@see tvg_canvas_add()

@since 1.0

func (Shape) GetPath ¶

func (shape Shape) GetPath() ([]PathCommand, []Point, error)

GetPath retrieves the current path data of the shape.

This function provides access to the shape's path data, including the commands and points that define the path.

@param[out] cmds Pointer to the array of commands representing the path.
							Can be @c nullptr if this information is not needed.
@param[out] cmdsCnt Pointer to the variable that receives the number of commands in the @p cmds array.
									Can be @c nullptr if this information is not needed.
@param[out] pts Pointer to the array of two-dimensional points that define the path.
							Can be @c nullptr if this information is not needed.
@param[out] ptsCnt Pointer to the variable that receives the number of points in the @p pts array.
								Can be @c nullptr if this information is not needed.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note If any of the arguments are @c nullptr, that value will be ignored.

func (Shape) GetRef ¶

func (paint Shape) GetRef() int

GetRef retrieves the current reference count of the Tvg_Paint object.

This method provides the current reference count, allowing the user to check the shared ownership state of the Tvg_Paint object.

@param[in] paint The Tvg_Paint object to return the reference count.

@return The current reference count of the Tvg_Paint object.

@see tvg_paint_ref()
@see tvg_paint_unref()

@since 1.0

func (Shape) GetStrokeCap ¶

func (shape Shape) GetStrokeCap() (StrokeCap, error)

GetStrokeCap gets the stroke cap style used for stroking the path.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] cap The cap style value.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer passed as an argument.

func (Shape) GetStrokeColor ¶

func (shape Shape) GetStrokeColor() (int, int, int, int, error)

GetStrokeColor gets the shape's stroke color.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] r The red color channel value in the range [0 ~ 255]. The default value is 0.
@param[out] g The green color channel value in the range [0 ~ 255]. The default value is 0.
@param[out] b The blue color channel value in the range [0 ~ 255]. The default value is 0.
@param[out] a The alpha channel value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION No stroke was set.

func (Shape) GetStrokeDash ¶

func (shape Shape) GetStrokeDash() ([]float32, float32, error)

GetStrokeDash gets the dash pattern of the stroke.

The function does not allocate any memory.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] dashPattern The array of consecutive pair values of the dash length and the gap length.
@param[out] cnt The size of the @p dashPattern array.
@param[out] offset The shift of the starting point within the repeating dash pattern.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer passed as an argument.
@since 1.0

func (Shape) GetStrokeGradient ¶

func (shape Shape) GetStrokeGradient() (Gradient, error)

GetStrokeGradient gets the gradient fill of the shape's stroke.

The function does not allocate any memory.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] grad The gradient fill.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer passed as an argument.

func (Shape) GetStrokeJoin ¶

func (shape Shape) GetStrokeJoin() (StrokeJoin, error)

GetStrokeJoin gets the stroke join method

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] join The join style value.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer passed as an argument.

func (Shape) GetStrokeMiterlimit ¶

func (shape Shape) GetStrokeMiterlimit() (float32, error)

GetStrokeMiterlimit gets the stroke miterlimit.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] miterlimit The stroke miterlimit.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer passed as an argument.

@since 0.11

func (Shape) GetStrokeWidth ¶

func (shape Shape) GetStrokeWidth() (float32, error)

GetStrokeWidth gets the shape's stroke width.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[out] width The stroke width.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer passed as an argument.

func (Shape) GetType ¶

func (paint Shape) GetType() (Type, error)

GetType gets the unique value of the paint instance indicating the instance type.

@param[in] paint The Tvg_Paint object of which to get the type value.
@param[out] type The unique type of the paint instance type.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 1.0

func (Shape) GetVisible ¶

func (paint Shape) GetVisible() bool

GetVisibile gets the current visibility status of the Paint object.

@param[in] paint The Tvg_Paint object to return the visibility status.

@return true if the object is visible and will be rendered.
				false if the object is hidden and will not be rendered.

@see tvg_paint_set_visible()

@since 1.0

func (Shape) Intersects ¶

func (paint Shape) Intersects(x int, y int, width int, height int) bool

Intersects checks whether a given region intersects the filled area of the paint.

This function determines whether the specified rectangular region—defined by (`x`, `y`, `w`, `h`)— intersects the geometric fill region of the paint object.

This is useful for hit-testing purposes, such as detecting whether a user interaction (e.g., touch or click) occurs within a painted region.

The paint must be updated in a Canvas beforehand—typically after the Canvas has been drawn and synchronized.

@param[in] paint A Tvg_Paint pointer to the shape object to be tested.
@param[in] x The x-coordinate of the top-left corner of the test region.
@param[in] y The y-coordinate of the top-left corner of the test region.
@param[in] w The width of the region to test. Must be greater than 0; defaults to 1.
@param[in] h The height of the region to test. Must be greater than 0; defaults to 1.

@return @c true if any part of the region intersects the filled area; otherwise, @c false.

@note To test a single point, set the region size to w = 1, h = 1.
@note For efficiency, an AABB (axis-aligned bounding box) test is performed internally before precise hit detection.
@note This test does not take into account the results of blending or masking.
@note This test does take into account the the hidden paints as well. @see tvg_paint_set_visible().
@since 1.0

func (Shape) LineTo ¶

func (shape Shape) LineTo(x float32, y float32) error

LineTo adds a new point to the sub-path, which results in drawing a line from the current point to the given end-point.

The value of the current point is set to the given end-point.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] x The horizontal coordinate of the end-point of the line.
@param[in] y The vertical coordinate of the end-point of the line.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note In case this is the first command in the path, it corresponds to the tvg_shape_move_to() call.

func (Shape) MoveTo ¶

func (shape Shape) MoveTo(x float32, y float32) error

MoveTo sets the initial point of the sub-path.

The value of the current point is set to the given point.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] x The horizontal coordinate of the initial point of the sub-path.
@param[in] y The vertical coordinate of the initial point of the sub-path.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

func (Shape) Ref ¶

func (paint Shape) Ref() int

Ref increments the reference count for the Tvg_Paint object.

This method increases the reference count of Tvg_Paint object, allowing shared ownership and control over its lifetime.

@param[in] paint The Tvg_Paint object to increase the reference count.

@return The updated reference count after the increment by 1.

@warning Please ensure that each call to tvg_paint_ref() is paired with a corresponding call to tvg_paint_unref() to prevent a dangling instance.

@see tvg_paint_unref()
@see tvg_paint_get_ref()

@since 1.0

func (Shape) Rel ¶

func (paint Shape) Rel() error

Rel safely releases a Tv_Paint object.

This is the counterpart to the `new()` API, and releases the given Paint object safely, handling @c nullptr and managing ownership properly.

@param[in] paint A Tvg_Paint object to release.

func (Shape) Reset ¶

func (shape Shape) Reset() error

Reset resets the shape path properties.

The color, the fill and the stroke properties are retained.

@param[in] paint A Tvg_Paint pointer to the shape object.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note The memory, where the path data is stored, is not deallocated at this stage for caching effect.

func (Shape) Ret_transform ¶

func (paint Shape) Ret_transform() (Matrix, error)

GetTransform gets the matrix of the affine transformation of the given Tvg_Paint object.

In case no transformation was applied, the identity matrix is returned.

@param[in] paint The Tvg_Paint object of which to get the transformation matrix.
@param[out] m The 3x3 augmented matrix.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Shape) Rotate ¶

func (paint Shape) Rotate(degree float32) error

Rotate rotates the given Tvg_Paint by the given angle.

The angle in measured clockwise from the horizontal axis. The rotational axis passes through the point on the object with zero coordinates.

@param[in] paint The Tvg_Paint object to be rotated.
@param[in] degree The value of the rotation angle in degrees.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Shape) Scale ¶

func (paint Shape) Scale(factor float32) error

Scale scales the given Tvg_Paint object by the given factor.

@param[in] paint The Tvg_Paint object to be scaled.
@param[in] factor The value of the scaling factor. The default value is 1.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Shape) SetBlendMethod ¶

func (paint Shape) SetBlendMethod(method BlendMethod) error

SetBlendMethod sets the blending method for the paint object.

The blending feature allows you to combine colors to create visually appealing effects, including transparency, lighting, shading, and color mixing, among others. its process involves the combination of colors or images from the source paint object with the destination (the lower layer image) using blending operations. The blending operation is determined by the chosen @p BlendMethod, which specifies how the colors or images are combined.

@param[in] paint The Tvg_Paint object of which to set the blend method.
@param[in] method The blending method to be set.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 0.15

func (Shape) SetClip ¶

func (paint Shape) SetClip(clipper Paint) error

SetClip clips the drawing region of the paint object.

This function restricts the drawing area of the paint object to the specified shape's paths.

@param[in] paint The target object of the clipping.
@param[in] clipper The shape object as the clipper.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION if the target has already belonged to another paint.
@retval TVG_RESULT_NOT_SUPPORTED If the @p clipper type is not Shape.

@see tvg_paint_get_clip()

@since 1.0

func (Shape) SetFillColor ¶

func (shape Shape) SetFillColor(r uint8, g uint8, b uint8, a uint8) error

SetFillColor sets the shape's solid color.

The parts of the shape defined as inner are colored.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] r The red color channel value in the range [0 ~ 255]. The default value is 0.
@param[in] g The green color channel value in the range [0 ~ 255]. The default value is 0.
@param[in] b The blue color channel value in the range [0 ~ 255]. The default value is 0.
@param[in] a The alpha channel value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque. The default value is 0.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note Either a solid color or a gradient fill is applied, depending on what was set as last.
@see tvg_shape_set_fill_rule()

func (Shape) SetFillRule ¶

func (shape Shape) SetFillRule(rule FillRule) error

SetFillRule sets the fill rule for the shape.

Specifies how the interior of the shape is determined when its path intersects itself. The default fill rule is @c TVG_FILL_RULE_NON_ZERO.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] rule The fill rule to apply to the shape.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

func (Shape) SetGradient ¶

func (shape Shape) SetGradient(gradient Gradient) error

SetGradient sets the gradient fill for all of the figures from the path.

The parts of the shape defined as inner are filled.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] grad The gradient fill.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_MEMORY_CORRUPTION An invalid Tvg_Gradient pointer.

@note Either a solid color or a gradient fill is applied, depending on what was set as last.
@see tvg_shape_set_fill_rule()

func (Shape) SetMaskMethod ¶

func (paint Shape) SetMaskMethod(target Paint, method MaskMethod) error

SetMaskMethod sets the masking target object and the masking method.

@param[in] paint The source object of the masking.
@param[in] target The target object of the masking.
@param[in] method The method used to mask the source object with the target.

@retval TVG_RESULT_INSUFFICIENT_CONDITION if the target has already belonged to another paint.

func (Shape) SetOpacity ¶

func (paint Shape) SetOpacity(opacity uint8) error

SetOpacity sets the opacity of the given Tvg_Paint.

@param[in] paint The Tvg_Paint object of which the opacity value is to be set.
@param[in] opacity The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note Setting the opacity with this API may require multiple renderings using a composition. It is recommended to avoid changing the opacity if possible.

func (Shape) SetPaintOrder ¶

func (shape Shape) SetPaintOrder(strokeFirst bool) error

SetPaintOrder sets the rendering order of the stroke and the fill.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] strokeFirst If @c true the stroke is rendered before the fill, otherwise the stroke is rendered as the second one (the default option).

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@since 0.10

func (Shape) SetStrokeCap ¶

func (shape Shape) SetStrokeCap(strokeCap StrokeCap) error

SetStrokeCap sets the cap style used for stroking the path.

The cap style specifies the shape to be used at the end of the open stroked sub-paths.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] cap The cap style value. The default value is @c TVG_STROKE_CAP_SQUARE.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

func (Shape) SetStrokeColor ¶

func (shape Shape) SetStrokeColor(r uint, g uint, b uint, a uint) error

SetStrokeColor sets the shape's stroke color.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] r The red color channel value in the range [0 ~ 255]. The default value is 0.
@param[in] g The green color channel value in the range [0 ~ 255]. The default value is 0.
@param[in] b The blue color channel value in the range [0 ~ 255]. The default value is 0.
@param[in] a The alpha channel value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note If the stroke width is 0 (default), the stroke will not be visible regardless of the color.
@note Either a solid color or a gradient fill is applied, depending on what was set as last.

@see tvg_shape_set_stroke_width()
@see tvg_shape_set_stroke_gradient()

func (Shape) SetStrokeDash ¶

func (shape Shape) SetStrokeDash(pattern []float32, offset float32) error

SetStrokeDash sets the shape's stroke dash pattern.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] dashPattern An array of alternating dash and gap lengths.
@param[in] cnt The size of the @p dashPattern array.
@param[in] offset The shift of the starting point within the repeating dash pattern, from which the pattern begins to be applied.

@retval TVG_RESULT_INVALID_ARGUMENT In case @p dashPattern is @c nullptr and @p cnt > 0 or @p dashPattern is not @c nullptr and @p cnt is zero.

@note To reset the stroke dash pattern, pass @c nullptr to @p dashPattern and zero to @p cnt.
@note Values of @p dashPattern less than zero are treated as zero.
@note If all values in the @p dashPattern are equal to or less than 0, the dash is ignored.
@note If the @p dashPattern contains an odd number of elements, the sequence is repeated in the same

order to form an even-length pattern, preserving the alternation of dashes and gaps.

@since 1.0

func (Shape) SetStrokeGradient ¶

func (shape Shape) SetStrokeGradient(grad Gradient) error

SetStrokeGradient sets the gradient fill of the stroke for all of the figures from the path.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] grad The gradient fill.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_MEMORY_CORRUPTION An invalid Tvg_Gradient pointer or an error with accessing it.

@note Either a solid color or a gradient fill is applied, depending on what was set as last.

@see tvg_shape_set_stroke_color()

func (Shape) SetStrokeJoin ¶

func (shape Shape) SetStrokeJoin(join StrokeJoin) error

SetStrokeJoin sets the join style for stroked path segments.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] join The join style value. The default value is @c TVG_STROKE_JOIN_BEVEL.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

func (Shape) SetStrokeMiterlimit ¶

func (shape Shape) SetStrokeMiterlimit(miterlimit float32) error

SetStrokeMiterlimit sets the stroke miterlimit.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] miterlimit The miterlimit imposes a limit on the extent of the stroke join when the @c TVG_STROKE_JOIN_MITER join style is set. The default value is 4.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer or Unsupported @p miterlimit values (less than zero).

@since 0.11

func (Shape) SetStrokeWidth ¶

func (shape Shape) SetStrokeWidth(width float32) error

SetStrokeWidth sets the stroke width for the path.

This function defines the thickness of the stroke applied to all figures in the path object. A stroke is the outline drawn along the edges of the path's geometry.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] width The width of the stroke in pixels. Must be positive value. (The default is 0)

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note A value of @p width 0 disables the stroke.

@see tvg_shape_set_stroke_color()

func (Shape) SetTransform ¶

func (paint Shape) SetTransform(matrix Matrix) error

SetTransform transforms the given Tvg_Paint using the augmented transformation matrix.

The augmented matrix of the transformation is expected to be given.

@param[in] paint The Tvg_Paint object to be transformed.
@param[in] m The 3x3 augmented matrix.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Shape) SetTrimpath ¶

func (shape Shape) SetTrimpath(begin float32, end float32, simultaneous bool) error

SetTrimpath sets the trim of the shape along the defined path segment, allowing control over which part of the shape is visible.

If the values of the arguments @p begin and @p end exceed the 0-1 range, they are wrapped around in a manner similar to angle wrapping, effectively treating the range as circular.

@param[in] paint A Tvg_Paint pointer to the shape object.
@param[in] begin Specifies the start of the segment to display along the path.
@param[in] end Specifies the end of the segment to display along the path.
@param[in] simultaneous Determines how to trim multiple paths within a single shape. If set to @c true (default), trimming is applied simultaneously to all paths;
											Otherwise, all paths are treated as a single entity with a combined length equal to the sum of their individual lengths and are trimmed as such.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@since 1.0

func (Shape) SetVisible ¶

func (paint Shape) SetVisible(visible bool) error

SetVisible sets the visibility of the Paint object.

This is useful for selectively excluding paint objects during rendering.

@param[in] paint The Tvg_Paint object to set the visibility status.
@param[in] on A boolean flag indicating visibility. The default is @c true.
						@c true, the object will be rendered by the engine.
						@c false, the object will be excluded from the drawing process.

@note An invisible object is not considered inactive—it may still participate
			in internal update processing if its prope

			rties are updated, but it will not
			be taken into account for the final drawing output. To completely deactivate
			a paint object, remove it from the canvas.

@see tvg_paint_get_visible()
@see tvg_canvas_remove()

@since 1.0

func (Shape) Translate ¶

func (paint Shape) Translate(x float32, y float32) error

Translate moves the given Tvg_Paint in a two-dimensional space.

The origin of the coordinate system is in the upper-left corner of the canvas. The horizontal and vertical axes point to the right and down, respectively.

@param[in] paint The Tvg_Paint object to be shifted.
@param[in] x The value of the horizontal shift.
@param[in] y The value of the vertical shift.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Shape) Unref ¶

func (paint Shape) Unref(free bool) int

Unref decrements the reference count for the Tvg_Paint object.

This method decreases the reference count of the Tvg_Paint object by 1. If the reference count reaches zero and the @p free flag is set to true, the instance is automatically deleted.

@param[in] paint The Tvg_Paint object to decrease the reference count.
@param[in] free Flag indicating whether to delete the Paint instance when the reference count reaches zero.

@return The updated reference count after the decrement.

@see tvg_paint_ref()
@see tvg_paint_get_ref()

@since 1.0

func (Text) Align ¶

func (text Text) Align(x float32, y float32) error

Align sets text alignment or anchor per axis.

If layout width/height is set on an axis, align within the layout box. Otherwise, treat it as an anchor within the text bounds which point of the text box is pinned to the paint position.

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] x Horizontal alignment/anchor in [0..1]: 0=left/start, 0.5=center, 1=right/end. (Default is 0)
@param[in] y Vertical alignment/anchor in [0..1]: 0=top, 0.5=middle, 1=bottom. (Default is 0)

@since 1.0

@see tvg_text_layout()

func (Text) Duplicate ¶

func (text Text) Duplicate() Text

Duplicate duplicates a Text.

Creates a new object and sets its all properties as in the original object.

@param[in] paint The Tvg_Paint object to be copied.

@return A copied Tvg_Paint object if succeed, @c nullptr otherwise.

func (Text) GetAABB ¶

func (paint Text) GetAABB() (float32, float32, float32, float32, error)

GetAABB retrieves the axis-aligned bounding box (AABB) of the paint object in canvas space.

Returns the bounding box of the paint as an axis-aligned bounding box (AABB), with all relevant transformations applied. The returned values @p x, @p y, @p w, @p h, may have invalid if the operation fails. Thus, please check the retval.

This bounding box can be used to determine the actual rendered area of the object on the canvas, for purposes such as hit-testing, culling, or layout calculations.

@param[in] paint The Tvg_Paint object of which to get the bounds.
@param[out] x The x-coordinate of the upper-left corner of the bounding box.
@param[out] y The y-coordinate of the upper-left corner of the bounding box.
@param[out] w The width of the bounding box.
@param[out] h The height of the bounding box.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid @p paint.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If it failed to compute the bounding box (mostly due to invalid path information).

@see tvg_paint_get_obb()
@see tvg_canvas_update()

func (Text) GetClip ¶

func (paint Text) GetClip() (any, bool)

GetClip gets the clipper shape of the paint object.

This function returns the clipper that has been previously set to this paint object.

@return The shape object used as the clipper, or @c nullptr if no clipper is set.

@see tvg_paint_set_clip()

@since 1.0

func (Text) GetMaskMethod ¶

func (paint Text) GetMaskMethod(target Paint) (MaskMethod, error)

GetMaskMethod gets the masking target object and the masking method.

@param[in] paint The source object of the masking.
@param[out] target The target object of the masking.
@param[out] method The method used to mask the source object with the target.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Text) GetOBB ¶

func (paint Text) GetOBB() ([4]Point, error)

GetOBB retrieves the object-oriented bounding box (OBB) of the paint object in canvas space.

This function returns the bounding box of the paint, as an oriented bounding box (OBB) after transformations are applied. The returned values @p pt4 may have invalid if the operation fails. Thus, please check the retval.

This bounding box can be used to obtain the transformed bounding region in canvas space by taking the geometry's axis-aligned bounding box (AABB) in the object's local coordinate space and applying the object's transformations.

@param[in] paint The Tvg_Paint object of which to get the bounds.
@param[out] pt4 An array of four points representing the bounding box. The array size must be 4.

@retval TVG_RESULT_INVALID_ARGUMENT @p paint or @p pt4 is invalid.
@retval TVG_RESULT_INSUFFICIENT_CONDITION If it failed to compute the bounding box (mostly due to invalid path information).

@see tvg_paint_get_aabb()
@see tvg_canvas_update()

@since 1.0

func (Text) GetOpacity ¶

func (paint Text) GetOpacity() (uint8, error)

GetOpacity gets the opacity of the given Tvg_Paint.

@param[in] paint The Tvg_Paint object of which to get the opacity value.
@param[out] opacity The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

func (Text) GetParent ¶

func (paint Text) GetParent() (any, bool)

GetParent retrieves the parent paint object.

This function returns a pointer to the parent object if the current paint belongs to one. Otherwise, it returns @c nullptr.

@param[in] paint The Tvg_Paint object of which to get the scene.

@return A pointer to the parent object if available, otherwise @c nullptr.

@see tvg_scene_add()
@see tvg_canvas_add()

@since 1.0

func (Text) GetRef ¶

func (paint Text) GetRef() int

GetRef retrieves the current reference count of the Tvg_Paint object.

This method provides the current reference count, allowing the user to check the shared ownership state of the Tvg_Paint object.

@param[in] paint The Tvg_Paint object to return the reference count.

@return The current reference count of the Tvg_Paint object.

@see tvg_paint_ref()
@see tvg_paint_unref()

@since 1.0

func (Text) GetType ¶

func (paint Text) GetType() (Type, error)

GetType gets the unique value of the paint instance indicating the instance type.

@param[in] paint The Tvg_Paint object of which to get the type value.
@param[out] type The unique type of the paint instance type.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 1.0

func (Text) GetVisible ¶

func (paint Text) GetVisible() bool

GetVisibile gets the current visibility status of the Paint object.

@param[in] paint The Tvg_Paint object to return the visibility status.

@return true if the object is visible and will be rendered.
				false if the object is hidden and will not be rendered.

@see tvg_paint_set_visible()

@since 1.0

func (Text) Intersects ¶

func (paint Text) Intersects(x int, y int, width int, height int) bool

Intersects checks whether a given region intersects the filled area of the paint.

This function determines whether the specified rectangular region—defined by (`x`, `y`, `w`, `h`)— intersects the geometric fill region of the paint object.

This is useful for hit-testing purposes, such as detecting whether a user interaction (e.g., touch or click) occurs within a painted region.

The paint must be updated in a Canvas beforehand—typically after the Canvas has been drawn and synchronized.

@param[in] paint A Tvg_Paint pointer to the shape object to be tested.
@param[in] x The x-coordinate of the top-left corner of the test region.
@param[in] y The y-coordinate of the top-left corner of the test region.
@param[in] w The width of the region to test. Must be greater than 0; defaults to 1.
@param[in] h The height of the region to test. Must be greater than 0; defaults to 1.

@return @c true if any part of the region intersects the filled area; otherwise, @c false.

@note To test a single point, set the region size to w = 1, h = 1.
@note For efficiency, an AABB (axis-aligned bounding box) test is performed internally before precise hit detection.
@note This test does not take into account the results of blending or masking.
@note This test does take into account the the hidden paints as well. @see tvg_paint_set_visible().
@since 1.0

func (Text) Layout ¶

func (text Text) Layout(width float32, h float32) error

Layout sets the virtual layout box (constraints) for the text.

If width/height is set on an axis, that axis is constrained by a virtual layout box and the text may wrap/align inside it. If width/height == 0, the axis is unconstrained and @ref tvg_text_align() acts as an anchor on that axis.

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] w Layout width in user space. Use 0 for no horizontal constraint. (Default is 0)
@param[in] h Layout height in user space. Use 0 for no vertical constraint. (Default is 0)

@note This defines constraints only; alignment/anchoring is controlled by @ref align().
@since 1.0

@see tvg_text_align()
@see tvg_text_spacing()

func (Text) Ref ¶

func (paint Text) Ref() int

Ref increments the reference count for the Tvg_Paint object.

This method increases the reference count of Tvg_Paint object, allowing shared ownership and control over its lifetime.

@param[in] paint The Tvg_Paint object to increase the reference count.

@return The updated reference count after the increment by 1.

@warning Please ensure that each call to tvg_paint_ref() is paired with a corresponding call to tvg_paint_unref() to prevent a dangling instance.

@see tvg_paint_unref()
@see tvg_paint_get_ref()

@since 1.0

func (Text) Rel ¶

func (paint Text) Rel() error

Rel safely releases a Tv_Paint object.

This is the counterpart to the `new()` API, and releases the given Paint object safely, handling @c nullptr and managing ownership properly.

@param[in] paint A Tvg_Paint object to release.

func (Text) Ret_transform ¶

func (paint Text) Ret_transform() (Matrix, error)

GetTransform gets the matrix of the affine transformation of the given Tvg_Paint object.

In case no transformation was applied, the identity matrix is returned.

@param[in] paint The Tvg_Paint object of which to get the transformation matrix.
@param[out] m The 3x3 augmented matrix.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Text) Rotate ¶

func (paint Text) Rotate(degree float32) error

Rotate rotates the given Tvg_Paint by the given angle.

The angle in measured clockwise from the horizontal axis. The rotational axis passes through the point on the object with zero coordinates.

@param[in] paint The Tvg_Paint object to be rotated.
@param[in] degree The value of the rotation angle in degrees.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Text) Scale ¶

func (paint Text) Scale(factor float32) error

Scale scales the given Tvg_Paint object by the given factor.

@param[in] paint The Tvg_Paint object to be scaled.
@param[in] factor The value of the scaling factor. The default value is 1.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Text) SetBlendMethod ¶

func (paint Text) SetBlendMethod(method BlendMethod) error

SetBlendMethod sets the blending method for the paint object.

The blending feature allows you to combine colors to create visually appealing effects, including transparency, lighting, shading, and color mixing, among others. its process involves the combination of colors or images from the source paint object with the destination (the lower layer image) using blending operations. The blending operation is determined by the chosen @p BlendMethod, which specifies how the colors or images are combined.

@param[in] paint The Tvg_Paint object of which to set the blend method.
@param[in] method The blending method to be set.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.

@since 0.15

func (Text) SetClip ¶

func (paint Text) SetClip(clipper Paint) error

SetClip clips the drawing region of the paint object.

This function restricts the drawing area of the paint object to the specified shape's paths.

@param[in] paint The target object of the clipping.
@param[in] clipper The shape object as the clipper.

@retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION if the target has already belonged to another paint.
@retval TVG_RESULT_NOT_SUPPORTED If the @p clipper type is not Shape.

@see tvg_paint_get_clip()

@since 1.0

func (Text) SetColor ¶

func (text Text) SetColor(r uint8, g uint8, b uint8) error

SetColor sets the text solid color.

@param[in] paint A Tvg_Paint pointer to the text object.
@param[in] r The red color channel value in the range [0 ~ 255]. The default value is 0.
@param[in] g The green color channel value in the range [0 ~ 255]. The default value is 0.
@param[in] b The blue color channel value in the range [0 ~ 255]. The default value is 0.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the @p paint argument.

@note Either a solid color or a gradient fill is applied, depending on what was set as last.

@see tvg_text_set_font()
@see tvg_text_set_outline()

@since 0.15

func (Text) SetFont ¶

func (text Text) SetFont(name string) error

SetFont sets the font family for the text.

This function specifies the name of the font to be used when rendering text.

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] name The name of the font. This should match a font available through the canvas backend.
								If set to @c nullptr, ThorVG will attempt to select a fallback font available on the engine.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the @p paint argument.
@retval TVG_RESULT_INSUFFICIENT_CONDITION  The specified @p name cannot be found.

@note This function only sets the font family name. Use @ref size() to define the font size.
@note If the @p name is not specified, ThorVG will select an available fallback font.

@see tvg_text_set_size()
@see tvg_font_load()

@since 1.0

func (Text) SetGradient ¶

func (text Text) SetGradient(gradient Gradient) error

SetGradient sets the gradient fill for the text.

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] grad The linear or radial gradient fill

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the @p paint argument.
@retval TVG_RESULT_MEMORY_CORRUPTION An invalid Tvg_Gradient pointer.

@note Either a solid color or a gradient fill is applied, depending on what was set as last.
@see tvg_text_set_font()

@since 0.15

func (Text) SetItalic ¶

func (text Text) SetItalic(shear float32) error

SetItalic applies an italic (slant) transformation to the text.

This function applies a shear transformation to simulate an italic (oblique) style for the current text object. The shear factor determines the degree of slant applied along the X-axis.

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] shear The shear factor to apply. A value of 0.0 applies no slant, while values around 0.5 result in a strong slant.
								Must be in the range [0.0, 0.5]. Recommended value is 0.18.

@note The @p shear factor will be clamped to the valid range if it exceeds the limits.
@note This does not require the font itself to be italic.
			It visually simulates the effect by applying a transformation matrix.

@warning Excessive slanting may cause visual distortion depending on the font and size.

@see tvg_text_set_font()

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the @p paint argument.

@since 1.0

func (Text) SetMaskMethod ¶

func (paint Text) SetMaskMethod(target Paint, method MaskMethod) error

SetMaskMethod sets the masking target object and the masking method.

@param[in] paint The source object of the masking.
@param[in] target The target object of the masking.
@param[in] method The method used to mask the source object with the target.

@retval TVG_RESULT_INSUFFICIENT_CONDITION if the target has already belonged to another paint.

func (Text) SetOpacity ¶

func (paint Text) SetOpacity(opacity uint8) error

SetOpacity sets the opacity of the given Tvg_Paint.

@param[in] paint The Tvg_Paint object of which the opacity value is to be set.
@param[in] opacity The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.

@note Setting the opacity with this API may require multiple renderings using a composition. It is recommended to avoid changing the opacity if possible.

func (Text) SetOutline ¶

func (text Text) SetOutline(width float32, r uint8, g uint8, b uint8) error

SetOutline sets an outline (stroke) around the text object.

This function adds an outline to the text with the specified width and RGB color. The outline enhances the visibility of the text by rendering a stroke around its glyphs.

@param[in] text A Tvg_Paint pointer to the text object.
@param width The width of the outline. Must be positive value. (The default is 0)
@param r     Red component of the outline color (0–255).
@param g     Green component of the outline color (0–255).
@param b     Blue component of the outline color (0–255).

@note To disable the outline, set @p width to 0.
@see tvg_text_set_fill_color() to set the main text fill color.

@since 1.0

func (Text) SetSize ¶

func (text Text) SetSize(size float32) error

SetSize sets the font size for the text.

This function sets the font size used during text rendering. The size is specified in point units, and supports floating-point precision for smooth scaling and animation effects.

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] size The font size in points. Must be greater than 0.0.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr passed as the @p paint argument.
@retval TVG_RESULT_INVALID_ARGUMENT if the @p size is less than or equal to 0.

@note Use this function in combination with @ref font() to fully define text appearance.
@note Fractional sizes (e.g., 12.5) are supported for sub-pixel rendering and animations.

@see tvg_text_set_font()

@since 1.0

func (Text) SetText ¶

func (text Text) SetText(utf8 string) error

SetText assigns the given unicode text to be rendered.

This function sets the unicode text that will be displayed by the rendering system. The text is set according to the specified UTF encoding method, which defaults to UTF-8.

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] utf8 The multi-byte text encoded with utf8 string to be rendered.

@since 1.0

func (Text) SetTransform ¶

func (paint Text) SetTransform(matrix Matrix) error

SetTransform transforms the given Tvg_Paint using the augmented transformation matrix.

The augmented matrix of the transformation is expected to be given.

@param[in] paint The Tvg_Paint object to be transformed.
@param[in] m The 3x3 augmented matrix.

@retval TVG_RESULT_INVALID_ARGUMENT A @c nullptr is passed as the argument.

func (Text) SetVisible ¶

func (paint Text) SetVisible(visible bool) error

SetVisible sets the visibility of the Paint object.

This is useful for selectively excluding paint objects during rendering.

@param[in] paint The Tvg_Paint object to set the visibility status.
@param[in] on A boolean flag indicating visibility. The default is @c true.
						@c true, the object will be rendered by the engine.
						@c false, the object will be excluded from the drawing process.

@note An invisible object is not considered inactive—it may still participate
			in internal update processing if its prope

			rties are updated, but it will not
			be taken into account for the final drawing output. To completely deactivate
			a paint object, remove it from the canvas.

@see tvg_paint_get_visible()
@see tvg_canvas_remove()

@since 1.0

func (Text) Spacing ¶

func (text Text) Spacing(letter float32, line float32) error

Spacing sets the spacing scale factors for text layout.

This function adjusts the letter spacing (horizontal space between glyphs) and line spacing (vertical space between lines of text) using scale factors.

Both values are relative to the font's default metrics: - The letter spacing is applied as a scale factor to the glyph's advance width. - The line spacing is applied as a scale factor to the glyph's advance height.

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] letter The scale factor for letter spacing.
										Values > 1.0 increase spacing, values < 1.0 decrease it.
										Must be greater than or equal to 0.0. (default: 1.0)

@param[in] line The scale factor for line spacing.
									Values > 1.0 increase line spacing, values < 1.0 decrease it.
									Must be greater than or equal to 0.0. (default: 1.0)

  @since 1.0

func (Text) Translate ¶

func (paint Text) Translate(x float32, y float32) error

Translate moves the given Tvg_Paint in a two-dimensional space.

The origin of the coordinate system is in the upper-left corner of the canvas. The horizontal and vertical axes point to the right and down, respectively.

@param[in] paint The Tvg_Paint object to be shifted.
@param[in] x The value of the horizontal shift.
@param[in] y The value of the vertical shift.

@retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer.
@retval TVG_RESULT_INSUFFICIENT_CONDITION in case a custom transform is applied.

@see tvg_paint_set_transform()

func (Text) Unref ¶

func (paint Text) Unref(free bool) int

Unref decrements the reference count for the Tvg_Paint object.

This method decreases the reference count of the Tvg_Paint object by 1. If the reference count reaches zero and the @p free flag is set to true, the instance is automatically deleted.

@param[in] paint The Tvg_Paint object to decrease the reference count.
@param[in] free Flag indicating whether to delete the Paint instance when the reference count reaches zero.

@return The updated reference count after the decrement.

@see tvg_paint_ref()
@see tvg_paint_get_ref()

@since 1.0

func (Text) WrapMode ¶

func (text Text) WrapMode(mode TextWrap) error

WrapMode sets the text wrapping mode for this text object.

This method controls how the text is laid out when it exceeds the available space. The wrapping mode determines whether text is truncated, wrapped by character or word, or adjusted automatically. An ellipsis mode is also available for truncation with "...".

@param[in] text A Tvg_Paint pointer to the text object.
@param[in] mode The wrapping strategy to apply. Default is @c TVG_TEXT_WRAP_NONE.

@see Tvg_Text_Wrap
@since 1.0