Skip to content

Commit

Permalink
Update Canvas docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sammycage committed Jun 21, 2024
1 parent f3030ae commit e5a87b5
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions include/plutobook.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -349,17 +349,17 @@ class PLUTOBOOK_API OutputStream {
class PLUTOBOOK_API Canvas {
public:
/**
* @brief Virtual destructor
* @brief Destructor
*/
virtual ~Canvas();

/**
* @brief flush
* @brief Flushes any pending drawing operations.
*/
void flush();

/**
* @brief finish
* @brief Finishes all drawing operations and cleans up the canvas.
*/
void finish();

Expand All @@ -384,24 +384,24 @@ class PLUTOBOOK_API Canvas {
void rotate(float angle);

/**
* @brief Concatenates a custom transformation matrix to the current matrix.
* @param a The element at position (1, 1) of the transformation matrix.
* @param b The element at position (1, 2) of the transformation matrix.
* @param c The element at position (2, 1) of the transformation matrix.
* @param d The element at position (2, 2) of the transformation matrix.
* @param e The element at position (3, 1) of the transformation matrix.
* @param f The element at position (3, 2) of the transformation matrix.
* @brief Multiplies the current transformation matrix with the specified matrix.
* @param a The horizontal scaling factor.
* @param b The horizontal skewing factor.
* @param c The vertical skewing factor.
* @param d The vertical scaling factor.
* @param e The horizontal translation distance.
* @param f The vertical translation distance.
*/
void transform(float a, float b, float c, float d, float e, float f);

/**
* @brief Sets the transformation matrix directly.
* @param a The element at position (1, 1) of the transformation matrix.
* @param b The element at position (1, 2) of the transformation matrix.
* @param c The element at position (2, 1) of the transformation matrix.
* @param d The element at position (2, 2) of the transformation matrix.
* @param e The element at position (3, 1) of the transformation matrix.
* @param f The element at position (3, 2) of the transformation matrix.
* @brief Resets the current transformation to the identity matrix.
* @param a The horizontal scaling factor.
* @param b The horizontal skewing factor.
* @param c The vertical skewing factor.
* @param d The vertical scaling factor.
* @param e The horizontal translation distance.
* @param f The vertical translation distance.
*/
void setMatrix(float a, float b, float c, float d, float e, float f);

Expand All @@ -411,7 +411,7 @@ class PLUTOBOOK_API Canvas {
void resetMatrix();

/**
* @brief Clips drawing to a rectangular region.
* @brief Intersects the current clip with the specified rectangle.
* @param x The x-coordinate of the top-left corner of the rectangle.
* @param y The y-coordinate of the top-left corner of the rectangle.
* @param width width The width of the rectangle.
Expand All @@ -420,7 +420,7 @@ class PLUTOBOOK_API Canvas {
void clipRect(float x, float y, float width, float height);

/**
* @brief Clears the entire surface with the specified color.
* @brief Clears the canvas surface with the specified color.
* @param red The red component of the color.
* @param green The green component of the color.
* @param blue The blue component of the color.
Expand Down

0 comments on commit e5a87b5

Please sign in to comment.