Skip to content

Removed references to deleted methods EditableImage:WritePixels and EditableImage:ReadPixels and rewrote select descriptions accordingly. #1063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 28, 2025
Merged

Removed references to deleted methods EditableImage:WritePixels and EditableImage:ReadPixels and rewrote select descriptions accordingly. #1063

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
48e06ba
removed references to deleted methods :WritePixels and :ReadPixels
Finchasaurus Mar 27, 2025
b9a7440
Merge branch 'main' into editable-image/remove-references-to-removed-…
IgnisRBX Mar 28, 2025
b8fac63
Apply suggestions from code review
IgnisRBX Mar 28, 2025
a37086b
Apply suggestions from code review
IgnisRBX Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 22 additions & 30 deletions content/en-us/reference/engine/classes/EditableImage.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ inherits:
- Object
tags:
- NotCreatable
deprecation_message: ''
deprecation_message: ""
properties:
- name: EditableImage.Size
summary: |
Expand All @@ -79,7 +79,7 @@ properties:
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
deprecation_message: ""
security:
read: None
write: None
Expand All @@ -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: []
Expand Down Expand Up @@ -146,9 +146,9 @@ methods:
added image.
returns:
- type: void
summary: ''
summary: ""
tags: []
deprecation_message: ''
deprecation_message: ""
security: None
thread_safety: Unsafe
capabilities: []
Expand Down Expand Up @@ -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: []
Expand Down Expand Up @@ -236,9 +236,9 @@ methods:
image.
returns:
- type: void
summary: ''
summary: ""
tags: []
deprecation_message: ''
deprecation_message: ""
security: None
thread_safety: Unsafe
capabilities: []
Expand Down Expand Up @@ -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: []
Expand Down Expand Up @@ -339,9 +339,9 @@ methods:
added image.
returns:
- type: void
summary: ''
summary: ""
tags: []
deprecation_message: ''
deprecation_message: ""
security: None
thread_safety: Unsafe
capabilities: []
Expand Down Expand Up @@ -384,9 +384,9 @@ methods:
added image.
returns:
- type: void
summary: ''
summary: ""
tags: []
deprecation_message: ''
deprecation_message: ""
security: None
thread_safety: Unsafe
capabilities: []
Expand All @@ -395,11 +395,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.
Expand All @@ -424,7 +420,7 @@ methods:
`Size.X * Size.Y * 4` bytes.
tags:
- CustomLuaState
deprecation_message: ''
deprecation_message: ""
security: None
thread_safety: Safe
capabilities: []
Expand All @@ -433,11 +429,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.
Expand All @@ -463,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: []
Expand Down