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 extern void
105 _mesa_update_draw_buffer_bounds(struct gl_context *ctx,
106                                 struct gl_framebuffer *drawFb);
107 
108 extern void
109 _mesa_update_framebuffer_visual(struct gl_context *ctx,
110 				struct gl_framebuffer *fb);
111 
112 extern void
113 _mesa_update_framebuffer(struct gl_context *ctx,
114                          struct gl_framebuffer *readFb,
115                          struct gl_framebuffer *drawFb);
116 
117 extern GLboolean
118 _mesa_source_buffer_exists(struct gl_context *ctx, GLenum format);
119 
120 extern GLboolean
121 _mesa_dest_buffer_exists(struct gl_context *ctx, GLenum format);
122 
123 extern GLenum
124 _mesa_get_color_read_type(struct gl_context *ctx,
125                           struct gl_framebuffer *fb,
126                           const char *caller);
127 
128 extern GLenum
129 _mesa_get_color_read_format(struct gl_context *ctx,
130                             struct gl_framebuffer *fb,
131                             const char *caller);
132 
133 extern struct gl_renderbuffer *
134 _mesa_get_read_renderbuffer_for_format(const struct gl_context *ctx,
135                                        GLenum format);
136 
137 extern void
138 _mesa_print_framebuffer(const struct gl_framebuffer *fb);
139 
140 extern bool
141 _mesa_is_front_buffer_reading(const struct gl_framebuffer *fb);
142 
143 extern bool
144 _mesa_is_front_buffer_drawing(const struct gl_framebuffer *fb);
145 
146 extern bool
147 _mesa_is_multisample_enabled(const struct gl_context *ctx);
148 
149 extern bool
150 _mesa_is_alpha_test_enabled(const struct gl_context *ctx);
151 
152 extern bool
153 _mesa_is_alpha_to_coverage_enabled(const struct gl_context *ctx);
154 
155 #endif /* FRAMEBUFFER_H */
156