OS_SpriteOp in Documentation

Programmer's Reference Manuals

» Part 15 – SWI Calls

» OS

» OS_SpriteOp

OS_SpriteOp

(SWI &2E)

Entry
R0	Reason code + Area value
All other registers dependent on reason code

Exit
R0	Preserved
All other registers dependent on reason code

Use

The purpose of this call is to perform different sprite related actions.

Notes

The action performed depends on the reason code value in R0.

Area Value

The area value can be added to the reason code in R0 to specify how to select a sprite. R1 and R2 are often used to select a sprite.

Value	R1	R2
+0	System Sprite area¹	Sprite name
+256	Sprite area	Sprite name
+512	Sprite area	Sprite pointer

¹ It is strongly recommended not to use the system sprite area.

When using a sprite name, the string can be terminated with a space or control character (i.e. any character <= 32). Sprite name matching is case-insensitive, and only the first 12 bytes of the supplied name will be examined.

This SWI is indirected via SpriteV.

Reason Codes

#	Hex #	Action
2	&02	Screen save ²
3	&03	Screen load
8	&08	Read area control block
9	&09	Initialise sprite area ²
10	&0A	Load sprite file ²
11	&0B	Merge sprite file
12	&0C	Save sprite file
13	&0D	Return name
14	&0E	Get sprite from cursor ²
15	&0F	Create sprite ²
16	&10	Get sprite from user coords ²
17	&11	Verify sprite area
24	&18	Select sprite/Get address
25	&19	Delete sprite ²
26	&1A	Rename sprite ²
27	&1B	Copy sprite ²
28	&1C	Put sprite to screen
29	&1D	Create mask ²
30	&1E	Remove mask ²
31	&1F	Insert row ² ³
32	&20	Delete row ² ³
33	&21	Flip about x axis ²
34	&22	Put sprite at user coords
35	&23	Append sprite ¹ ²
36	&24	Set pointer shape ¹
37	&25	Create/remove palette ¹
38	&26	Create/remove alpha ¹ ²
40	&28	Read sprite info
41	&29	Read pixel colour
42	&2A	Write pixel colour ²
43	&2B	Read pixel mask
44	&2C	Write pixel mask ²
45	&2D	Insert column ² ³
46	&2E	Delete column ² ³
47	&2F	Flip about y axis ²
48	&30	Plot sprite mask
49	&31	Plot mask at user coords
50	&32	Plot mask scaled ¹
51	&33	Paint char scaled? ¹
52	&34	Paint sprite scaled ¹
53	&35	Put sprite grey scaled? ¹
54	&36	Remove left-hand wastage ²
55	&37	Plot mask transformed ¹
56	&38	Plot sprite transformed ¹
57	&39	Insert/delete rows ¹ ²
58	&3A	Insert/delete columns ¹ ²
60	&3C	Switch output to sprite ²
61	&3D	Switch output to mask ²
62	&3E	Read save area size
65	&41	Tile sprite scaled ¹

¹ Requires SpriteExtend module to be loaded.

² Not available via Wimp_SpriteOp

³ Originally these calls were implemented directly in the kernel, but as of RISC OS 3.5 they require SpriteExtend to be loaded.

OS_SpriteOp

Programmer's Reference Manuals

» Part 15 – SWI Calls

» OS

» OS_SpriteOp

OS_SpriteOp

(SWI &2E)

Use

Notes

Area Value

Reason Codes

See also

Search the Wiki

Social

Commercial use

ROOL Store

Donate! Why?

Navigation