xref: /haiku/docs/user/interface/GraphicsDefs.dox (revision f5821a1aee77d3b9a979b42c68a79e50b5ebaefe)
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
29
30/*!
31	\var B_SOLID_HIGH
32
33	Draw using the view's high color.
34*/
35
36
37/*!
38	\var B_MIXED_COLORS
39
40	Draw a pattern of the view's high and low colors.
41*/
42
43
44/*!
45	\var B_SOLID_LOW
46
47	Draw using the view's low color.
48*/
49
50
51/*!
52	\enum source_alpha
53	\ingroup interface
54
55	Blending alpha mode constants.
56*/
57
58
59/*!
60	\var source_alpha B_PIXEL_ALPHA
61
62	Use the alpha value of each pixel when drawing a bitmap.
63*/
64
65
66/*!
67	\var source_alpha B_CONSTANT_ALPHA
68
69	Use the alpha channel of the view's high color.
70*/
71
72
73/*!
74	\enum alpha_function
75	\ingroup interface
76
77	Blending alpha function constants.
78*/
79
80
81/*!
82	\var alpha_function B_ALPHA_OVERLAY
83
84	Used for drawing a image with transparency over an opaque background.
85*/
86
87
88/*!
89	\var alpha_function B_ALPHA_COMPOSITE
90
91	Used to composite two or more transparent images together offscreen to
92	produce a new image drawn using \c B_ALPHA_OVERLAY mode.
93*/
94