commands/genbmp/genbmp.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # genbmp.cif
       
     2 # 
       
     3 # Copyright (c) 2010 Accenture. All rights reserved.
       
     4 # This component and the accompanying materials are made available
       
     5 # under the terms of the "Eclipse Public License v1.0"
       
     6 # which accompanies this distribution, and is available
       
     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 # 
       
     9 # Initial Contributors:
       
    10 # Accenture - Initial contribution
       
    11 #
       
    12 
       
    13 ==name genbmp
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Generates simple bitmap files that contain text.
       
    18 
       
    19 ==argument filename file_name
       
    20 
       
    21 The name of the bitmap file generate.
       
    22 
       
    23 ==argument string text multiple
       
    24 
       
    25 The text to be rendered into the bitmap. For multiple lines, enclose the text for each line in quotes.
       
    26 
       
    27 ==option uint f foreground-color
       
    28 
       
    29 The color (in 32 bit RGB format) to render the text in. Defaults to white (0xffffff).
       
    30 
       
    31 ==option uint b background-color
       
    32 
       
    33 The color (in 32 bit RGB format) to render the background behind the text in. Defaults to black (0x000000).
       
    34 
       
    35 ==option int w width
       
    36 
       
    37 The width (in pixels) of the bitmap to be created. Defaults to 150.
       
    38 
       
    39 ==option int H height
       
    40 
       
    41 The height (in pixels) of the bitmap to be created. Defaults to 150.
       
    42 
       
    43 ==option string t typeface
       
    44 
       
    45 The name of the typeface to render the text with. Defaults to 'Arial'.
       
    46 
       
    47 ==option int m max-font-height
       
    48 
       
    49 The maximum height of the font to use in pixels. Defaults to 15.
       
    50 
       
    51 ==option int g gap
       
    52 
       
    53 The gap (in pixels) between the text and the bitmap edge and also between each line of text. Defaults to 10.
       
    54 
       
    55 ==copyright
       
    56 
       
    57 Copyright (c) 2009-2010 Accenture. All rights reserved.
       
    58