[SHAPES] Add more detail to comment for DrawPixel (#4344)

* Update raylib_api.* by CI * Add comment that draw pixel uses geometry and may be slow * Update raylib_api.* by CI --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
raysan5 · Sep 27, 2024 · 0573ef0 · 0573ef0
1 parent 55e8346
commit 0573ef0
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/parser/output/raylib_api.json b/parser/output/raylib_api.json
@@ -5274,7 +5274,7 @@
     },
     {
       "name": "DrawPixel",
-      "description": "Draw a pixel",
+      "description": "Draw a pixel using geometry [Can be slow, use with care]",
       "returnType": "void",
       "params": [
         {
@@ -5293,7 +5293,7 @@
     },
     {
       "name": "DrawPixelV",
-      "description": "Draw a pixel (Vector version)",
+      "description": "Draw a pixel using geometry (Vector version) [Can be slow, use with care]",
       "returnType": "void",
       "params": [
         {

diff --git a/parser/output/raylib_api.lua b/parser/output/raylib_api.lua
@@ -4614,7 +4614,7 @@ return {
     },
     {
       name = "DrawPixel",
-      description = "Draw a pixel",
+      description = "Draw a pixel using geometry [Can be slow, use with care]",
       returnType = "void",
       params = {
         {type = "int", name = "posX"},
@@ -4624,7 +4624,7 @@ return {
     },
     {
       name = "DrawPixelV",
-      description = "Draw a pixel (Vector version)",
+      description = "Draw a pixel using geometry (Vector version) [Can be slow, use with care]",
       returnType = "void",
       params = {
         {type = "Vector2", name = "position"},

diff --git a/parser/output/raylib_api.txt b/parser/output/raylib_api.txt
@@ -2102,14 +2102,14 @@ Function 207: GetShapesTextureRectangle() (0 input parameters)
 Function 208: DrawPixel() (3 input parameters)
   Name: DrawPixel
   Return type: void
-  Description: Draw a pixel
+  Description: Draw a pixel using geometry [Can be slow, use with care]
   Param[1]: posX (type: int)
   Param[2]: posY (type: int)
   Param[3]: color (type: Color)
 Function 209: DrawPixelV() (2 input parameters)
   Name: DrawPixelV
   Return type: void
-  Description: Draw a pixel (Vector version)
+  Description: Draw a pixel using geometry (Vector version) [Can be slow, use with care]
   Param[1]: position (type: Vector2)
   Param[2]: color (type: Color)
 Function 210: DrawLine() (5 input parameters)

diff --git a/parser/output/raylib_api.xml b/parser/output/raylib_api.xml
@@ -1297,12 +1297,12 @@
         </Function>
         <Function name="GetShapesTextureRectangle" retType="Rectangle" paramCount="0" desc="Get texture source rectangle that is used for shapes drawing">
         </Function>
-        <Function name="DrawPixel" retType="void" paramCount="3" desc="Draw a pixel">
+        <Function name="DrawPixel" retType="void" paramCount="3" desc="Draw a pixel using geometry [Can be slow, use with care]">
             <Param type="int" name="posX" desc="" />
             <Param type="int" name="posY" desc="" />
             <Param type="Color" name="color" desc="" />
         </Function>
-        <Function name="DrawPixelV" retType="void" paramCount="2" desc="Draw a pixel (Vector version)">
+        <Function name="DrawPixelV" retType="void" paramCount="2" desc="Draw a pixel using geometry (Vector version) [Can be slow, use with care]">
             <Param type="Vector2" name="position" desc="" />
             <Param type="Color" name="color" desc="" />
         </Function>

diff --git a/src/raylib.h b/src/raylib.h
@@ -1234,8 +1234,8 @@ RLAPI Texture2D GetShapesTexture(void);                                 // Get t
 RLAPI Rectangle GetShapesTextureRectangle(void);                        // Get texture source rectangle that is used for shapes drawing
 
 // Basic shapes drawing functions
-RLAPI void DrawPixel(int posX, int posY, Color color);                                                   // Draw a pixel
-RLAPI void DrawPixelV(Vector2 position, Color color);                                                    // Draw a pixel (Vector version)
+RLAPI void DrawPixel(int posX, int posY, Color color);                                                   // Draw a pixel using geometry [Can be slow, use with care]
+RLAPI void DrawPixelV(Vector2 position, Color color);                                                    // Draw a pixel using geometry (Vector version) [Can be slow, use with care]
 RLAPI void DrawLine(int startPosX, int startPosY, int endPosX, int endPosY, Color color);                // Draw a line
 RLAPI void DrawLineV(Vector2 startPos, Vector2 endPos, Color color);                                     // Draw a line (using gl lines)
 RLAPI void DrawLineEx(Vector2 startPos, Vector2 endPos, float thick, Color color);                       // Draw a line (using triangles/quads)