Drawing functions improvements and fixes

FileEX · FileEX · commit 951a34d3e06f · 2025-12-15T17:08:42.000+01:00
diff --git a/functions/Drawing/dxCreateScreenSource.yaml b/functions/Drawing/dxCreateScreenSource.yaml
@@ -23,4 +23,6 @@ client:
     constructorclass: DxScreenSource
   notes:
     - type: tip
-      content: Successful screen source creation is not guaranteed, and may fail due to hardware or memory limitations. You should always check to see if this function has returned **false**.
+      content: |
+        - It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using **dxCreateScreenSource**.
+        - Successful screen source creation is not guaranteed, and may fail due to hardware or memory limitations. You should always check to see if this function has returned **false**.
diff --git a/functions/Drawing/dxCreateTexture.yaml b/functions/Drawing/dxCreateTexture.yaml
@@ -100,3 +100,7 @@ client:
           description: Added **textureType** and **depth** arguments.
         - version: 1.3.0-9.04035
           description: Added **textureEdge** argument.
+        - version: 1.6.0-9.22188
+          description: Added **rgb** and **xrgb** texture format.
+  version:
+    updated: 1.6.0-9.22188
diff --git a/functions/Drawing/dxDrawImageSection.yaml b/functions/Drawing/dxDrawImageSection.yaml
@@ -62,7 +62,7 @@ client:
     default: 'false'
   examples:
   - path: examples/dxDrawImageSection-1.lua
-    description: Example 1The example draws a section of an image.
+    description: The example draws a section of an image.
   returns:
     values:
     - type: bool
diff --git a/functions/Drawing/dxDrawMaterialLine3D.yaml b/functions/Drawing/dxDrawMaterialLine3D.yaml
@@ -63,7 +63,7 @@ client:
   notes:
     - type: tip
       content: |
-        - The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.
+        - The 3D line with a large **width** value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for **faceToward**.
         - 3D lines are drawn at a particular place in the [game processing order](/reference/Game_Processing_Order), so use [[onClientPreRender]] for drawing if you are attaching them to world elements.
   meta:
     - changelog:
diff --git a/functions/Drawing/dxDrawText.yaml b/functions/Drawing/dxDrawText.yaml
@@ -23,9 +23,9 @@ client:
     default: topY
   - name: color
     type: int
-    description: The color of the text, a value produced by tocolor or 0xAARRGGBB
+    description: The color of the text, a value produced by [[tocolor]] or 0xAARRGGBB
       (AA = alpha, RR = red, GG = green, BB = blue).
-    default: white
+    default: '0xFFFFFFFF'
   - name: textSize
     type: float
     description: The size of the text scale.
diff --git a/functions/Drawing/dxDrawWiredSphere.yaml b/functions/Drawing/dxDrawWiredSphere.yaml
@@ -22,7 +22,7 @@ client:
     type: float
     description: A width of line.
   - name: iterations
-    type: uint
+    type: int
     description: Number 1, 2, 3 or 4. 1 mean low density, 4 mean high.
   examples:
   - path: examples/dxDrawWiredSphere-1.lua
diff --git a/functions/Drawing/dxGetFontHeight.yaml b/functions/Drawing/dxGetFontHeight.yaml
@@ -1,7 +1,6 @@
 client:
   name: dxGetFontHeight
-  description: This function retrieves the theoretical height of a certain piece of
-    text, if it were to be drawn using [[dxDrawText]].
+  description: This function returns the height of a **single line** of text for the given font. If you want to check the height of the entire multi-line text, use [[dxGetTextSize]].
   parameters:
   - name: scale
     type: float
diff --git a/functions/Drawing/dxGetPixelColor.yaml b/functions/Drawing/dxGetPixelColor.yaml
@@ -1,7 +1,7 @@
 client:
   name: dxGetPixelColor
   pair: dxSetPixelColor
-  description: This function gets the color of a single pixel from [pixels](/reference/Pixels) contained in a string. It only works with `plain` format pixels.
+  description: This function gets the color of a single pixel from [pixels](/reference/Pixels) contained in a string.
   parameters:
   - name: pixels
     type: string
@@ -24,4 +24,7 @@ client:
       name: b
     - type: int
       name: a
-    description: Returns 4 int s representing the rgba color value of the pixel if succesful, or **false** if invalid arguments were passed to the function.
+    description: Returns 4 int s representing the rgba color value of the pixel if succesful, or **false** if invalid arguments were passed to the function.
+  notes:
+    - type: info
+      content: It only works with `plain` format pixels.
diff --git a/functions/Drawing/dxGetPixelsFormat.yaml b/functions/Drawing/dxGetPixelsFormat.yaml
@@ -13,5 +13,5 @@ client:
     values:
     - type: string
       name: pixels format
-      templateList: pixels-format
+      templateList: pixels-format_with_dds
     description: Returns the format of the pixels if successful, **false** if invalid arguments were passed to the function.
diff --git a/functions/Drawing/dxGetPixelsSize.yaml b/functions/Drawing/dxGetPixelsSize.yaml
@@ -1,6 +1,6 @@
 client:
   name: dxGetPixelsSize
-  description: This function gets the dimensions of [pixels](/reference/Pixels) contained in a string. It works with all pixel formats.
+  description: This function gets the dimensions of [pixels](/reference/Pixels) contained in a string. It works with **all** pixel formats.
   parameters:
   - name: pixels
     type: string
diff --git a/functions/Drawing/dxGetTextSize.yaml b/functions/Drawing/dxGetTextSize.yaml
@@ -1,6 +1,6 @@
 client:
   name: dxGetTextSize
-  description: This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using [[dxDrawText]].
+  description: This function retrieves the width and height (in pixels) of a certain piece of text, if it were to be drawn using [[dxDrawText]].
   parameters:
   - name: text
     type: string
diff --git a/functions/Drawing/dxGetTexturePixels.yaml b/functions/Drawing/dxGetTexturePixels.yaml
@@ -16,7 +16,7 @@ client:
     type: string
     description: Pixels format.
     default: '"plain"'
-    templateList: pixels-format
+    templateList: pixels-format_with_dds
   - name: textureFormat
     type: string
     description: A string representing the desired texture format. Use `unkown` to determine automatically based on texture format.
diff --git a/functions/Drawing/dxSetPixelColor.yaml b/functions/Drawing/dxSetPixelColor.yaml
@@ -1,7 +1,7 @@
 client:
   name: dxSetPixelColor
   pair: dxGetPixelColor
-  description: This function sets the color of a single pixel for [pixels](/reference/Pixels) contained in a string. It only works with `plain` format pixels.
+  description: This function sets the color of a single pixel for [pixels](/reference/Pixels) contained in a string.
   parameters:
   - name: pixels
     type: string
@@ -34,4 +34,7 @@ client:
     - type: bool
       name: result
     description: Returns **true** if successful, or **false** if invalid arguments were passed
-      to the function.
+      to the function.
+  notes:
+    - type: info
+      content: It only works with `plain` format pixels.
diff --git a/functions/Drawing/dxSetTexturePixels.yaml b/functions/Drawing/dxSetTexturePixels.yaml
@@ -1,7 +1,7 @@
 client:
   name: dxSetTexturePixels
   pair: dxGetTexturePixels
-  description: This function sets the [pixels](/reference/Pixels) of a [[texture]] element. It can be used with a standard texture, render target or screen source. Only `plain` pixels format is supported.
+  description: This function sets the [pixels](/reference/Pixels) of a [[texture]] element. It can be used with a standard texture, render target or screen source.
   parameters:
   - name: surfaceIndex
     type: int
@@ -46,6 +46,7 @@ client:
     content: 'By default the pixels are set starting at the top left corner of the texture. To set a different region, define a rectangular area using all four of these optional arguments: **x, y, width, height**.'
   - type: info
     content: |
+      - It only works with `plain` format pixels.
       - This function is slow and not something you want to be doing once a frame.
       - It is slower when reading pixels from a render target or screen source.
       - Is very slow indeed if the texture format is not `argb`.
diff --git a/functions/Drawing/examples/dxDrawText-3.lua b/functions/Drawing/examples/dxDrawText-3.lua
@@ -34,8 +34,8 @@ function wordWrap(text, maxwidth, scale, font, colorcoded)
     return lines
 end
 
-text = "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."
-formatedtext = wordWrap(text, 300, 1, "default", false) --wrap text
+local text = "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."
+local formatedtext = wordWrap(text, 300, 1, "default", false) --wrap text
 
 addEventHandler("onClientRender", root, function()
     dxDrawRectangle(5, 5, 300, 200, tocolor(0, 0, 0, 100)) --draw background
diff --git a/web/src/components/TemplateList.astro b/web/src/components/TemplateList.astro
@@ -192,6 +192,12 @@ const lists: Record<string, { id: number | string; label?: string }[]> = {
         {id: 'plain', label: ''},
         {id: 'png', label: ''},
         {id: 'jpeg', label: ''},
+    ],
+
+    'pixels-format_with_dds': [
+        {id: 'plain', label: ''},
+        {id: 'png', label: ''},
+        {id: 'jpeg', label: ''},
         {id: 'dds', label: ''},
     ],
 
@@ -207,9 +213,15 @@ const lists: Record<string, { id: number | string; label?: string }[]> = {
 
     'texture-formats': [
         {id: 'argb', label: 'RGB uncompressed 32 bit color (default).'},
+        {id: 'rgb', label: 'RGB uncompressed 16-bit RGB color format. Uses 5 bits for red, 6 bits for green, and 5 bits for blue.'},
+        {id: 'xrgb', label: 'RGB Uncompressed 32-bit RGB color format without alpha. Each pixel uses 8 bits for red, green, and blue. The highest 8 bits are unused (padding) and should be ignored.'},
         {id: 'dxt1', label: 'DXT1 compressed - Can take a fraction of a second longer to load (unless the file is already a DXT1 .dds). Uses 8 times less video memory than ARGB and **can speed up drawing**. Quality not as good as ARGB. **It supports alpha blending, but it can only be on or off, that is: either 0 or 255**.'},
         {id: 'dxt3', label: 'DXT3 compressed - Can take a fraction of a second longer to load (unless the file is already a DXT3 .dds). Uses 4 times less video memory than ARGB and **can speed up drawing**. Quality slightly better than DXT1 and supports crisp alpha blending.'},
         {id: 'dxt5', label: 'DXT5 compressed - Can take a fraction of a second longer to load (unless the file is already a DXT5 .dds). Uses 4 times less video memory than ARGB and **can speed up drawing**. Quality slightly better than DXT1 and supports smooth alpha blending.'},
+        {id: 'intz', label: 'Depth-stencil texture format used for sampling depth buffers in shaders.'},
+        {id: 'df24', label: '24-bit depth buffer format with optional stencil support, exposed as a texture.'},
+        {id: 'df16', label: '16-bit depth buffer format exposed as a texture.'},
+        {id: 'rawz', label: 'Raw depth texture format providing direct access to depth buffer values.'},
     ],
 
     'texture-edges': [
