The following are valid parameters that can be configured under the class section; all parameters are valid for both framebuffers and application windows.
Parameter | Description | Type | Possible Value(s) |
---|---|---|---|
alpha-mode | Indication of method of alpha blending to use for alpha compositing | string |
|
brightness | The brightness of a window. This configuration depends on the hardware; it can be configured, but may or may not take effect as determined by your hardware. | integer | -255..255 |
cbabc | Content-based automatic brightness control; specifies the content type of a window. This configuration depends on the hardware; it can be configured, but may or may not take effect as determined by your hardware. | string |
|
clip-position | The x- and y- position of a clipped rectangular viewport within the window buffers. This configuration must be in the form of: x-position,y-position. For example, clip-position = 100,100. | integer | x-position, y-position |
clip-size | The width and height (in pixels) of a clipped rectangular viewport within the window buffers. This configuration must be in the form of: widthxheight For example, clip-size = 100x100. | integer | widthxheight |
color | The background color of a window. Use RGB color code (HEX value) to identify the color. (e.g., blue = 0xff). | unsigned long integer (hex) |
|
contrast | The contrast adjustment of a window. This configuration depends on the hardware; it can be configured, but may or may not take effect as determined by your hardware. | integer | -128..127 |
display | The connection type to the display or the display on which the window will be shown. If the configuration is an integer, screen will interpret the integer as the indication of the display on which the window will be shown. Otherwise, if the configuration is a string that matches one of the valid display connection types, then Screen will interpret the string as the configuration of the display connection type. | string or integer |
|
format | The pixel format used by a window. Only one format is expected; this format must be supported by the display. | string |
|
global-alpha | The global alpha mode to apply to a window. | integer | 0..225 |
hue | The hue adjustment of a window. | integer | -128..127 |
id_string | A string to identify the contents of a window. | string | |
order | The distance from the bottom that is used when ordering window groups among each other. | long integer | |
pipeline | The pipeline identifier. This must refer to a pipeline defined in the wfd device section of the configuration file. | unsigned long integer | 1..3 |
rotation | The clockwise rotation of a window. Window rotation is absolute. | long integer |
|
saturation | The saturation adjustment of a window. | long integer | -128..127 |
source-position | The x and y coordinates of the top-left corner of a rectangular region within the window buffer representing the source viewport of a window. This is the portion of the window buffer that is to be displayed. This configuration must be in the format of: x-position,y-position. For example, source-position = 100,100. | integer | x-position, y-position |
source-size | The width and height (in pixels) of a region within the window buffer representing the source viewport of the window. This is the portion of the window buffer that is to be displayed. This configuration must be in the form of: widthxheight. For example, source-size = 100x100. | integer | |
static | Indicates whether or not the contents of a window are expected to change | unsigned long integer |
|
surface-size | The width and height of the window buffer. This configuration must be in the form of: widthxheight For example, surface-size = 100x100. | integer | |
interval | The minimum number of vsync periods between posts. | unsigned long integer | |
usage |
The intended usage for the window buffers; the resulting usage applied to the window
buffers is the bitwise OR of all the valid entries configured with this parameter.
You can configure this parameter using any of the following:
Note:
Note that all framebuffers share the same blitter; therefore if you configure multiple class sections and define the usage with a blitter in each, then the blitter named in the usage of the last class section in your configuration file will be used. This parameter differs from the blitter specified in the blit-config parameter under your globals section in graphics.conf. The blitter specified in the blit-config parameter is the blitter that Screen uses when your application explicitly calls the native blit API functions (screen_blit() and screen_fill()). When multiple usage flags are configured, each flag in the configuration must be separated by a comma or space. You can combine the blitter name with the usage flags in the same configuration line as long as it is separated by a comma or a space.
For example, the following are examples of valid entries for
configuring usage:
|
string |
|
visible | Indicates whether or not a window is visible. | string |
|
window-position | The x and y positions of the window screen coordinates. Remember that the position of child and embedded windows are relative to the parent window. For example, if the position of the application window is (10, 10) and the position of the child window is (10, 10), then the position of the child window on the screen is actually (20, 20). This configuration must be in the form of: x-position,y-position. For example, window-position = 10,10. | integer | x-position,y-position |
window-size | The width and height (in pixels) of a window. This configuration must be in the form of: widthxheight. For example, window-size = 100x100. | integer | widthxheight |
buffer-count | The number of buffers that are to be created or attached to a window. Beyond configuration, the buffer count can't be set; it can only be queried by the application. There is no explicit limit for this number. | integer | 3 (default) |