xref: /haiku/docs/user/interface/GraphicsDefs.dox (revision a3e794ae459fec76826407f8ba8c94cd3535f128)
1/*
2 * Copyright 2013 Haiku, Inc. All rights reserved.
3 * Distributed under the terms of the MIT License.
4 *
5 * Authors:
6 *		John Scipione, jscipione@gmail.com
7 *
8 * Corresponds to:
9 *		headers/os/interface/GraphicsDefs.h	hrev45737
10 *		src/kits/interface/GraphicsDefs.cpp	hrev45737
11 */
12
13
14/*!
15	\file GraphicsDefs.h
16	\ingroup interface
17	\ingroup libbe
18	\brief Graphics-related functions and variables used by the Interface Kit.
19*/
20
21
22/*!
23	\struct pattern
24	\ingroup interface
25	\ingroup libbe
26	\brief A pattern to use when drawing.
27
28	\since BeOS R3
29*/
30
31
32/*!
33	\var B_SOLID_HIGH
34
35	Draw using the view's high color.
36
37	\since BeOS R3
38*/
39
40
41/*!
42	\var B_MIXED_COLORS
43
44	Draw a pattern of the view's high and low colors.
45
46	\since BeOS R3
47*/
48
49
50/*!
51	\var B_SOLID_LOW
52
53	Draw using the view's low color.
54
55	\since BeOS R3
56*/
57
58
59/*!
60	\enum source_alpha
61	\ingroup interface
62
63	Blending alpha mode constants.
64
65	\since BeOS R3
66*/
67
68
69/*!
70	\var source_alpha B_PIXEL_ALPHA
71
72	Use the alpha value of each pixel when drawing a bitmap.
73
74	\since BeOS R3
75*/
76
77
78/*!
79	\var source_alpha B_CONSTANT_ALPHA
80
81	Use the alpha channel of the view's high color.
82
83	\since BeOS R3
84*/
85
86
87/*!
88	\enum alpha_function
89	\ingroup interface
90
91	Blending alpha function constants.
92
93	\since BeOS R3
94*/
95
96
97/*!
98	\var alpha_function B_ALPHA_OVERLAY
99
100	Used for drawing a image with transparency over an opaque background.
101
102	\since BeOS R3
103*/
104
105
106/*!
107	\var alpha_function B_ALPHA_COMPOSITE
108
109	Used to composite two or more transparent images together offscreen to
110	produce a new image drawn using \c B_ALPHA_OVERLAY mode.
111
112	\since BeOS R3
113*/
114