Skip to content

Commit 48e06ba

Browse files
authored
removed references to deleted methods :WritePixels and :ReadPixels
1 parent e836a98 commit 48e06ba

File tree

1 file changed

+23
-31
lines changed

1 file changed

+23
-31
lines changed

content/en-us/reference/engine/classes/EditableImage.yaml

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ description: |
2929
property is set to a new asset ID.
3030
3131
#### Update Limitations
32-
32+
3333
Only a single `Class.EditableImage` can be updated per frame on the display
3434
side. For example, if you update three `Class.EditableImage` objects which are
3535
currently being displayed, it will take three frames for all of them to be updated.
@@ -60,7 +60,7 @@ inherits:
6060
- Object
6161
tags:
6262
- NotCreatable
63-
deprecation_message: ''
63+
deprecation_message: ""
6464
properties:
6565
- name: EditableImage.Size
6666
summary: |
@@ -78,7 +78,7 @@ properties:
7878
tags:
7979
- ReadOnly
8080
- NotReplicated
81-
deprecation_message: ''
81+
deprecation_message: ""
8282
security:
8383
read: None
8484
write: None
@@ -91,16 +91,16 @@ properties:
9191
writeCapabilities: []
9292
methods:
9393
- name: EditableImage:Destroy
94-
summary: ''
94+
summary: ""
9595
description: |
9696
Destroys the contents of the image, immediately reclaiming used memory.
9797
code_samples: []
9898
parameters: []
9999
returns:
100100
- type: void
101-
summary: ''
101+
summary: ""
102102
tags: []
103-
deprecation_message: ''
103+
deprecation_message: ""
104104
security: None
105105
thread_safety: Unsafe
106106
capabilities: []
@@ -145,9 +145,9 @@ methods:
145145
added image.
146146
returns:
147147
- type: void
148-
summary: ''
148+
summary: ""
149149
tags: []
150-
deprecation_message: ''
150+
deprecation_message: ""
151151
security: None
152152
thread_safety: Unsafe
153153
capabilities: []
@@ -181,9 +181,9 @@ methods:
181181
of the added image.
182182
returns:
183183
- type: void
184-
summary: ''
184+
summary: ""
185185
tags: []
186-
deprecation_message: ''
186+
deprecation_message: ""
187187
security: None
188188
thread_safety: Unsafe
189189
capabilities: []
@@ -235,9 +235,9 @@ methods:
235235
image.
236236
returns:
237237
- type: void
238-
summary: ''
238+
summary: ""
239239
tags: []
240-
deprecation_message: ''
240+
deprecation_message: ""
241241
security: None
242242
thread_safety: Unsafe
243243
capabilities: []
@@ -295,9 +295,9 @@ methods:
295295
(i.e. `Image.Size / 2`).
296296
returns:
297297
- type: void
298-
summary: ''
298+
summary: ""
299299
tags: []
300-
deprecation_message: ''
300+
deprecation_message: ""
301301
security: None
302302
thread_safety: Unsafe
303303
capabilities: []
@@ -338,9 +338,9 @@ methods:
338338
added image.
339339
returns:
340340
- type: void
341-
summary: ''
341+
summary: ""
342342
tags: []
343-
deprecation_message: ''
343+
deprecation_message: ""
344344
security: None
345345
thread_safety: Unsafe
346346
capabilities: []
@@ -383,9 +383,9 @@ methods:
383383
added image.
384384
returns:
385385
- type: void
386-
summary: ''
386+
summary: ""
387387
tags: []
388-
deprecation_message: ''
388+
deprecation_message: ""
389389
security: None
390390
thread_safety: Unsafe
391391
capabilities: []
@@ -394,11 +394,7 @@ methods:
394394
summary: |
395395
Reads a rectangular region of pixels into a buffer.
396396
description: |
397-
A version of `Class.EditableImage:ReadPixels()|ReadPixels()` that returns
398-
a buffer instead of a table. Each number in the buffer is a single byte,
399-
while each number in the table is 4 bytes, making
400-
`Class.EditableImage:ReadPixelsBuffer()|ReadPixelsBuffer()` more
401-
memory-efficient than `Class.EditableImage:ReadPixels()|ReadPixels()`.
397+
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).
402398
403399
Note that this method uses alpha instead of transparency, unlike the
404400
`Class.EditableImage` drawing methods.
@@ -423,7 +419,7 @@ methods:
423419
`Size.X * Size.Y * 4` bytes.
424420
tags:
425421
- CustomLuaState
426-
deprecation_message: ''
422+
deprecation_message: ""
427423
security: None
428424
thread_safety: Safe
429425
capabilities: []
@@ -432,11 +428,7 @@ methods:
432428
summary: |
433429
Writes a rectangular region of pixels into the image.
434430
description: |
435-
A version of `Class.EditableImage:WritePixels()|WritePixels()` that takes
436-
a buffer instead of a table. Each number in the buffer is a single byte,
437-
while each number in the table is 4 bytes, making
438-
`Class.EditableImage:WritePixelsBuffer()|WritePixelsBuffer()` more
439-
memory-efficient than `Class.EditableImage:WritePixels()|WritePixels()`.
431+
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).
440432
441433
Note that this method uses alpha instead of transparency, unlike the
442434
`Class.EditableImage` drawing methods.
@@ -462,10 +454,10 @@ methods:
462454
`Size.X * Size.Y * 4` bytes.
463455
returns:
464456
- type: void
465-
summary: ''
457+
summary: ""
466458
tags:
467459
- CustomLuaState
468-
deprecation_message: ''
460+
deprecation_message: ""
469461
security: None
470462
thread_safety: Unsafe
471463
capabilities: []

0 commit comments

Comments
 (0)