From 48e06bae53b85608839b8c43cc6dd6b939b86bf8 Mon Sep 17 00:00:00 2001 From: Finch Date: Thu, 27 Mar 2025 16:17:59 -0600 Subject: [PATCH 1/3] removed references to deleted methods :WritePixels and :ReadPixels --- .../engine/classes/EditableImage.yaml | 54 ++++++++----------- 1 file changed, 23 insertions(+), 31 deletions(-) diff --git a/content/en-us/reference/engine/classes/EditableImage.yaml b/content/en-us/reference/engine/classes/EditableImage.yaml index 487a08a73..2334dba1b 100644 --- a/content/en-us/reference/engine/classes/EditableImage.yaml +++ b/content/en-us/reference/engine/classes/EditableImage.yaml @@ -29,7 +29,7 @@ description: | property is set to a new asset ID. #### Update Limitations - + Only a single `Class.EditableImage` can be updated per frame on the display side. For example, if you update three `Class.EditableImage` objects which are currently being displayed, it will take three frames for all of them to be updated. @@ -60,7 +60,7 @@ inherits: - Object tags: - NotCreatable -deprecation_message: '' +deprecation_message: "" properties: - name: EditableImage.Size summary: | @@ -78,7 +78,7 @@ properties: tags: - ReadOnly - NotReplicated - deprecation_message: '' + deprecation_message: "" security: read: None write: None @@ -91,16 +91,16 @@ properties: writeCapabilities: [] methods: - name: EditableImage:Destroy - summary: '' + summary: "" description: | Destroys the contents of the image, immediately reclaiming used memory. code_samples: [] parameters: [] returns: - type: void - summary: '' + summary: "" tags: [] - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Unsafe capabilities: [] @@ -145,9 +145,9 @@ methods: added image. returns: - type: void - summary: '' + summary: "" tags: [] - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Unsafe capabilities: [] @@ -181,9 +181,9 @@ methods: of the added image. returns: - type: void - summary: '' + summary: "" tags: [] - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Unsafe capabilities: [] @@ -235,9 +235,9 @@ methods: image. returns: - type: void - summary: '' + summary: "" tags: [] - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Unsafe capabilities: [] @@ -295,9 +295,9 @@ methods: (i.e. `Image.Size / 2`). returns: - type: void - summary: '' + summary: "" tags: [] - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Unsafe capabilities: [] @@ -338,9 +338,9 @@ methods: added image. returns: - type: void - summary: '' + summary: "" tags: [] - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Unsafe capabilities: [] @@ -383,9 +383,9 @@ methods: added image. returns: - type: void - summary: '' + summary: "" tags: [] - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Unsafe capabilities: [] @@ -394,11 +394,7 @@ methods: summary: | Reads a rectangular region of pixels into a buffer. description: | - A version of `Class.EditableImage:ReadPixels()|ReadPixels()` that returns - a buffer instead of a table. Each number in the buffer is a single byte, - while each number in the table is 4 bytes, making - `Class.EditableImage:ReadPixelsBuffer()|ReadPixelsBuffer()` more - memory-efficient than `Class.EditableImage:ReadPixels()|ReadPixels()`. + Reads a rectangular region of pixels from an `Class.EditableImage` and returns it as a buffer. Each number in the buffer is a single byte, with pixels stored in a sequence of four bytes (red, green, blue, and alpha). Note that this method uses alpha instead of transparency, unlike the `Class.EditableImage` drawing methods. @@ -423,7 +419,7 @@ methods: `Size.X * Size.Y * 4` bytes. tags: - CustomLuaState - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Safe capabilities: [] @@ -432,11 +428,7 @@ methods: summary: | Writes a rectangular region of pixels into the image. description: | - A version of `Class.EditableImage:WritePixels()|WritePixels()` that takes - a buffer instead of a table. Each number in the buffer is a single byte, - while each number in the table is 4 bytes, making - `Class.EditableImage:WritePixelsBuffer()|WritePixelsBuffer()` more - memory-efficient than `Class.EditableImage:WritePixels()|WritePixels()`. + Writes a rectangular region of pixels to an `Class.EditableImage` from a buffer. Each number in the buffer is a single byte, with pixels stored in a sequence of four bytes (red, green, blue, and alpha). Note that this method uses alpha instead of transparency, unlike the `Class.EditableImage` drawing methods. @@ -462,10 +454,10 @@ methods: `Size.X * Size.Y * 4` bytes. returns: - type: void - summary: '' + summary: "" tags: - CustomLuaState - deprecation_message: '' + deprecation_message: "" security: None thread_safety: Unsafe capabilities: [] From b8fac631926d84b6c0dce6bb5f733299aa473231 Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Fri, 28 Mar 2025 08:05:13 -1000 Subject: [PATCH 2/3] Apply suggestions from code review --- .../engine/classes/EditableImage.yaml | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/content/en-us/reference/engine/classes/EditableImage.yaml b/content/en-us/reference/engine/classes/EditableImage.yaml index d5e69a950..5485da125 100644 --- a/content/en-us/reference/engine/classes/EditableImage.yaml +++ b/content/en-us/reference/engine/classes/EditableImage.yaml @@ -61,7 +61,7 @@ inherits: - Object tags: - NotCreatable -deprecation_message: "" +deprecation_message: '' properties: - name: EditableImage.Size summary: | @@ -79,7 +79,7 @@ properties: tags: - ReadOnly - NotReplicated - deprecation_message: "" + deprecation_message: '' security: read: None write: None @@ -92,16 +92,16 @@ properties: writeCapabilities: [] methods: - name: EditableImage:Destroy - summary: "" + summary: '' description: | Destroys the contents of the image, immediately reclaiming used memory. code_samples: [] parameters: [] returns: - type: void - summary: "" + summary: '' tags: [] - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] @@ -146,9 +146,9 @@ methods: added image. returns: - type: void - summary: "" + summary: '' tags: [] - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] @@ -182,9 +182,9 @@ methods: of the added image. returns: - type: void - summary: "" + summary: '' tags: [] - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] @@ -236,9 +236,9 @@ methods: image. returns: - type: void - summary: "" + summary: '' tags: [] - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] @@ -296,9 +296,9 @@ methods: (i.e. `Image.Size / 2`). returns: - type: void - summary: "" + summary: '' tags: [] - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] @@ -339,9 +339,9 @@ methods: added image. returns: - type: void - summary: "" + summary: '' tags: [] - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] @@ -384,9 +384,9 @@ methods: added image. returns: - type: void - summary: "" + summary: '' tags: [] - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] @@ -420,7 +420,7 @@ methods: `Size.X * Size.Y * 4` bytes. tags: - CustomLuaState - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Safe capabilities: [] @@ -455,10 +455,10 @@ methods: `Size.X * Size.Y * 4` bytes. returns: - type: void - summary: "" + summary: '' tags: - CustomLuaState - deprecation_message: "" + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] From a37086bf4451778bb3295497300661d09fc648ff Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Fri, 28 Mar 2025 08:06:34 -1000 Subject: [PATCH 3/3] Apply suggestions from code review --- content/en-us/reference/engine/classes/EditableImage.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/en-us/reference/engine/classes/EditableImage.yaml b/content/en-us/reference/engine/classes/EditableImage.yaml index 5485da125..6568fea54 100644 --- a/content/en-us/reference/engine/classes/EditableImage.yaml +++ b/content/en-us/reference/engine/classes/EditableImage.yaml @@ -395,7 +395,9 @@ methods: summary: | Reads a rectangular region of pixels into a buffer. description: | - Reads a rectangular region of pixels from an `Class.EditableImage` and returns it as a buffer. Each number in the buffer is a single byte, with pixels stored in a sequence of four bytes (red, green, blue, and alpha). + Reads a rectangular region of pixels from an `Class.EditableImage` and + returns it as a buffer. Each number in the buffer is a single byte, with pixels + stored in a sequence of four bytes (red, green, blue, and alpha). Note that this method uses alpha instead of transparency, unlike the `Class.EditableImage` drawing methods. @@ -429,7 +431,9 @@ methods: summary: | Writes a rectangular region of pixels into the image. description: | - Writes a rectangular region of pixels to an `Class.EditableImage` from a buffer. Each number in the buffer is a single byte, with pixels stored in a sequence of four bytes (red, green, blue, and alpha). + Writes a rectangular region of pixels to an `Class.EditableImage` from a + buffer. Each number in the buffer is a single byte, with pixels stored in a + sequence of four bytes (red, green, blue, and alpha). Note that this method uses alpha instead of transparency, unlike the `Class.EditableImage` drawing methods.