Device Emulator Skin XML Schema Reference

  • Article

Use the following reference as a model for developing custom skin files for the Device Emulator.

Note

You can use PNG as well as BMP image files.

Code

<?xml version="1.0" encoding="ISO-8859-1"?>

<skin>
    <view
        titleBar ="My Emulator skin"
        displayPosX="10"
        displayPosY="149"
        displayWidth="272"
        displayHeight="224"
        displayDepth="8"
        mappingImage="map.bmp"
        normalImage="up.bmp"
        downImage="down.bmp"
  
        <button
            toolTip="This is my ToolTip."
            onClick="  DOWN:Key_LeftShift
                       Key_Z
                       0x00000015
                       UP: Key_LeftShift
                       Key_A"
            onPressAndHold="Key_B"
            mappingColor="0x00FF00"
        />
    </view>
</skin>

Remarks

Item

Description

<skin> tag

Encapsulates the schema for an emulator skin. You can use only one <skin> tag in each .xml file.

<view> tag

Contains the schema for an emulator skin. You can use only one <view> tag per <skin> tag.

titleBar ="My Emulator skin" title bar element

Specifies the title of the window for the emulator.

displayPosX="10" and displayPosY="149" elements

Specifies the position at which to locate the window containing the display for the emulator within the window for the emulator skin. To make the display not visible, select coordinates that are off -screen.

displayWidth="272" and displayHeight="224" elements

Specifies the width and height of the display for the emulator. For width, choose an integer between 80 and 1024 that is divisible by 8. For height, choose an integer between 64 and 768.

displayDepth="8" element

Specifies the color depth of the display for the emulator. For color depth, choose 8, 16 or 32.

normalImage="up.bmp" element

Specifies the normal art file for the emulator skin, which is required. The normal art file specifies the size of the window for the emulator, and the appearance of the emulator skin.

mappingImage="map.bmp" element

Specifies the mapping file for the emulator skin. The mapping file is an optional file that defines the regions occupied by the buttons in the emulator skin.

downImage="down.bmp" element

Specifies the down art file for the emulator skin. The down art file is an optional file that specifies the appearance of the buttons on the emulator skin when the buttons are pressed.

<button> tag

Contains the description of a button on the emulator skin.

mappingColor="0x00FF00" element

Specifies the RGB color in the mapping file to use for the button. All pixels having this color in the mapping image represent the area in the emulator skin that you can click for this button. This area behaves as a mask through which the down art file is displayed when you press the button.

toolTip="This is my ToolTip." element

Optional. Specifies the text to appear when you move the pointer over the button.

onClick=" DOWN:Key_LeftShift

Key_Z

0x00000015

UP: Key_LeftShift

Key_A"

Optional. Specifies keyboard key presses to be passed to the engine when you press a button. Use hexadecimal or integer values corresponding to a raw keyboard scan code.

onPressAndHold="Key_B" element

Specifies keyboard events to repeat while a button on the emulator skin is being pressed. This feature supports all key codes except for the SHUTDOWN key code.

See Also

Tasks

How to: Customize an Emulator Skin

Concepts

Skins

Other Resources

Device Emulator Reference