1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25
26 #ifndef FRAMEBUFFER_H
27 #define FRAMEBUFFER_H
28
29 #include "mtypes.h"
30
31 struct gl_config;
32 struct gl_context;
33 struct gl_renderbuffer;
34
35 extern struct gl_framebuffer *
36 _mesa_new_framebuffer(struct gl_context *ctx, GLuint name);
37
38 extern void
39 _mesa_initialize_window_framebuffer(struct gl_framebuffer *fb,
40 const struct gl_config *visual);
41
42 extern void
43 _mesa_initialize_user_framebuffer(struct gl_framebuffer *fb, GLuint name);
44
45 extern void
46 _mesa_destroy_framebuffer(struct gl_framebuffer *buffer);
47
48 extern void
49 _mesa_free_framebuffer_data(struct gl_framebuffer *buffer);
50
51 extern void
52 _mesa_reference_framebuffer_(struct gl_framebuffer **ptr,
53 struct gl_framebuffer *fb);
54
55 static inline void
_mesa_reference_framebuffer(struct gl_framebuffer ** ptr,struct gl_framebuffer * fb)56 _mesa_reference_framebuffer(struct gl_framebuffer **ptr,
57 struct gl_framebuffer *fb)
58 {
59 if (*ptr != fb)
60 _mesa_reference_framebuffer_(ptr, fb);
61 }
62
63 extern void
64 _mesa_resize_framebuffer(struct gl_context *ctx, struct gl_framebuffer *fb,
65 GLuint width, GLuint height);
66
67
68 extern void
69 _mesa_resizebuffers( struct gl_context *ctx );
70
71 extern void
72 _mesa_intersect_scissor_bounding_box(const struct gl_context *ctx,
73 unsigned idx, int *bbox);
74
75 static inline GLuint
_mesa_geometric_width(const struct gl_framebuffer * buffer)76 _mesa_geometric_width(const struct gl_framebuffer *buffer)
77 {
78 return buffer->_HasAttachments ?
79 buffer->Width : buffer->DefaultGeometry.Width;
80 }
81
82 static inline GLuint
_mesa_geometric_height(const struct gl_framebuffer * buffer)83 _mesa_geometric_height(const struct gl_framebuffer *buffer)
84 {
85 return buffer->_HasAttachments ?
86 buffer->Height : buffer->DefaultGeometry.Height;
87 }
88
89 static inline GLuint
_mesa_geometric_samples(const struct gl_framebuffer * buffer)90 _mesa_geometric_samples(const struct gl_framebuffer *buffer)
91 {
92 return buffer->_HasAttachments ?
93 buffer->Visual.samples :
94 buffer->DefaultGeometry._NumSamples;
95 }
96
97 static inline GLuint
_mesa_geometric_layers(const struct gl_framebuffer * buffer)98 _mesa_geometric_layers(const struct gl_framebuffer *buffer)
99 {
100 return buffer->_HasAttachments ?
101 buffer->MaxNumLayers : buffer->DefaultGeometry.Layers;
102 }
103
104 #define Y_0_TOP 1
105 #define Y_0_BOTTOM 2
106
107 static inline GLuint
_mesa_fb_orientation(const struct gl_framebuffer * fb)108 _mesa_fb_orientation(const struct gl_framebuffer *fb)
109 {
110 if (fb && fb->FlipY) {
111 /* Drawing into a window (on-screen buffer).
112 *
113 * Negate Y scale to flip image vertically.
114 * The NDC Y coords prior to viewport transformation are in the range
115 * [y=-1=bottom, y=1=top]
116 * Hardware window coords are in the range [y=0=top, y=H-1=bottom] where
117 * H is the window height.
118 * Use the viewport transformation to invert Y.
119 */
120 return Y_0_TOP;
121 }
122 else {
123 /* Drawing into user-created FBO (very likely a texture).
124 *
125 * For textures, T=0=Bottom, so by extension Y=0=Bottom for rendering.
126 */
127 return Y_0_BOTTOM;
128 }
129 }
130
131 extern void
132 _mesa_update_draw_buffer_bounds(struct gl_context *ctx,
133 struct gl_framebuffer *drawFb);
134
135 extern void
136 _mesa_update_framebuffer_visual(struct gl_context *ctx,
137 struct gl_framebuffer *fb);
138
139 extern void
140 _mesa_update_framebuffer(struct gl_context *ctx,
141 struct gl_framebuffer *readFb,
142 struct gl_framebuffer *drawFb);
143
144 extern GLboolean
145 _mesa_source_buffer_exists(struct gl_context *ctx, GLenum format);
146
147 extern GLboolean
148 _mesa_dest_buffer_exists(struct gl_context *ctx, GLenum format);
149
150 extern GLenum
151 _mesa_get_color_read_type(struct gl_context *ctx,
152 struct gl_framebuffer *fb,
153 const char *caller);
154
155 extern GLenum
156 _mesa_get_color_read_format(struct gl_context *ctx,
157 struct gl_framebuffer *fb,
158 const char *caller);
159
160 extern struct gl_renderbuffer *
161 _mesa_get_read_renderbuffer_for_format(const struct gl_context *ctx,
162 GLenum format);
163
164 extern void
165 _mesa_print_framebuffer(const struct gl_framebuffer *fb);
166
167 extern bool
168 _mesa_is_multisample_enabled(const struct gl_context *ctx);
169
170 extern bool
171 _mesa_is_alpha_test_enabled(const struct gl_context *ctx);
172
173 void
174 _mesa_draw_buffer_allocate(struct gl_context *ctx);
175
176 #endif /* FRAMEBUFFER_H */
177