summaryrefslogtreecommitdiffstats
path: root/devel-docs/vbr.txt
blob: 01ac4a6965d1b0fb7417e1da3743aedabceca166 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
The GIMP Generated Brush File Format Version 1 (.vbr)
-----------------------------------------------------

Updated August 24, 2006.

The VBR format is used for "generated" brushes, that is, brushes
specified by a set of numerical parameters rather than a bitmap or
pixmap.  This format dates back to at least 1998, although it
has been tweaked several times.  The most recent tweak, in August
2004, added support for variable shapes.  Prior to this, the
version number used was always 1.0.  The version number used for
shaped brushes is 1.5. 

VBR files are plain text tiles, consisting of a set of fields
separated by line breaks.  The number of lines is variable, 10 if the
brush is "shaped", 8 otherwise.  All numerical fields are in float
format, with a dot as decimal separator, except the number of spikes
(for shaped brushes), which is an integer.

Non-shaped brushes:

Line 1: Must always contain the magic string "GIMP-VBR".

Line 2: Version number, always "1.0".

Line 3: The name of the brush.  This is a UTF-8 string, with a maximum
        length of 255 bytes.

Line 4: The brush spacing.

Line 5: The brush radius, in pixels.

Line 6: The brush hardness.

Line 7: The brush aspect ratio.

Line 8: The brush angle.


Shaped brushes:

Line 1: Must always contain the magic string "GIMP-VBR".

Line 2: Version number, always "1.5".

Line 3: The name of the brush.  This is a UTF-8 string, with a maximum
        length of 255 bytes.

Line 4: A string giving the shape of the brush.  Currently "circle",
        "square", and "diamond" are supported.  The possible shapes
        are defined by the GimpBrushGeneratedShape enum in
        core-enums.h.

Line 5: The brush spacing.

Line 6: The brush radius, in pixels.

Line 7: The number of spikes for the shape.

Line 8: The brush hardness.

Line 9: The brush aspect ratio.

Line 10: The brush angle.