862ba28c63da7650666425f3696a1c5490e0810d
[openblackhole/openblackhole-enigma2.git] / doc / SKINS
1 enigma2 skins
2 =============
3
4 A skin file is an XML file. Better read the existing skin file as an
5 example.
6
7 colors
8 ======
9
10 you can define alias names for different colors. the "value" is given as
11 #aarrggbb, or just #rrggbb.
12
13 windowstyle
14 ===========
15 here you can configure the "window style", i.e. the bord around windows.
16
17 screens
18 =======
19
20 these are the different widgets for the screens. they can also be embedded
21 in the screens itself.
22
23
24 A NOTE ABOUT PNGs
25 =================
26
27 Enigma can user either a 32bit argb or an 8bit pseudocolor output. In any
28 case, enigma uses 8bit PNGs for skins.
29
30 Though it would be easy to support 32bit pngs as well, it questionable if
31 this would be a great idea.
32
33 a.) the quality improvement is realative
34
35 you can use another palette for each png. that gives you unique 256 colors
36 for each skin element. Unless you have very big PNGs, you shouldn't be able
37 to notive the difference between 32bit and 8bit.
38
39 b.) 32bit skins wouldn't be compatible to 8bit displays
40
41 we still want to use enigma on hardware which is too slow for using a 32bit
42 output (after all, framebuffers can be very slow). Turning a 32bit bitmap
43 into an 8bit one is not ease and involves a lot of computations.
44
45 It would end up that you need to specify an 8bit and a 32bit version. Is
46 that really what you want?
47
48 c.) 32bit PNGs don't compress well
49
50 PNG is a lossless format. 32bit bitmap data is very hard to compress 
51 lossless.
52
53 We could use JPG, but jpgs don't offer a transparency channel, as far as i
54 know.
55
56
57 So, how to make your PNGs to look good?
58
59 It's simple. Edit them as 32bit ARGB (photoshop, gimp should be able to do
60 this fine!). Be sure that if you want alphatest, transparency really has an
61 alpha value of 0 / 255 (i.e. the extreme).
62
63 When you're finished, use "pngquant 256 <filename>" to process your PNGs to
64 be compatible with enigma.
65
66 note:
67 =====
68
69 if you're having less than 16 colors in your png file, pngquant generates a
70 16color (4bit) PNG, which is not really what we want. Either add more colors 
71 (evil workaround), fix enigma (good idea!) or patch pngquant to
72 always create 8bit pngs.
73
74 transparency:
75 =============
76
77 First, do not mix up transparency with alpha. I agree, both terms refer to
78 the same thing, but in our case, it's more complicated. As long as we don't
79 run on accelerated graphic, we need to differentiate between these two.
80
81 Alpha, in our context, is the ratio between the video and the OSD. Alpha = 0
82 means that OSD is completely visible, and no video, whereas Alpha = 1 (or
83 0xFF, if you express it so) means that there is only video.
84
85 Transparency, on the other hand, is OSD-only. When you have a background,
86 say a color, and you want to blit a picture on it, you can mix the
87 background with the picture. (*) This allows pixmap with a non-rectangular
88 shape.
89
90 Because of speed reasons, we don't support real alpha blending when not
91 running with acceleration. Instead, we use alpha testing. This means that a
92 special color is "transparent", whereas all other colors are not. This
93 colors *HAS TO BE AT INDEX 0*. As you can't count on automatic palette
94 merging (it's disabled when the target is 32bit, so you you're not
95 restricted to 8bit in total, only 8bit per pixmap), you have to tell your
96 gfx program to put the transparent color at index 0. This is what's normally
97 done, but in case transparency doesn't work correctly, you might want to
98 check this.
99
100
101 (*) Note, that, technically, if we start with a alpha=1 background (i.e.
102 only video), and alphablend on this, we generalized the problem enough that
103 we can handle both cases the same. But currently, we have to differentiate
104 between them, as we can't always alphablend.
105
106 lcd:
107 ====
108
109 Right now, most lcd-skins ("summary screens") are implemented right in the
110 python screens. However, you can override them with regular skinfiles.
111
112 There is some confusion about the actual size of the LCD. For now, assume it
113 to be 132x64 pixel, but think of the fact that some (most?) hardware can
114 only display either 128 (dreambox) or 120 (dbox2, dm8000) pixels
115 horizontally.
116
117 Right now some pixels will be cropped, currently at the right side. This
118 will be (hopefully) fixed soon, so that the used pixels are always in the
119 center.
120
121 So, bottom line:
122
123 Design LCD skins for 132x64, with no important items (text etc.) at the
124 outermost 6 pixels on each side. In doubt, leave them white.
125
126 LCD colorspace:
127 ===============
128
129 current LCDs are not able to display grayscale graphics. For this, there
130 will be a 1bit quantization. However, skins should be designed for 8bit
131 grayscale (and still look good in 1bit!), because some next-generation
132 display might be able to display some shades of gray - likely not 256, but
133 maybe 16 or so.