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_create_framebuffer(const struct gl_config *visual);
37 
38 extern struct gl_framebuffer *
39 _mesa_new_framebuffer(struct gl_context *ctx, GLuint name);
40 
41 extern void
42 _mesa_initialize_window_framebuffer(struct gl_framebuffer *fb,
43 				     const struct gl_config *visual);
44 
45 extern void
46 _mesa_initialize_user_framebuffer(struct gl_framebuffer *fb, GLuint name);
47 
48 extern void
49 _mesa_destroy_framebuffer(struct gl_framebuffer *buffer);
50 
51 extern void
52 _mesa_free_framebuffer_data(struct gl_framebuffer *buffer);
53 
54 extern void
55 _mesa_reference_framebuffer_(struct gl_framebuffer **ptr,
56                              struct gl_framebuffer *fb);
57 
58 static inline void
_mesa_reference_framebuffer(struct gl_framebuffer ** ptr,struct gl_framebuffer * fb)59 _mesa_reference_framebuffer(struct gl_framebuffer **ptr,
60                             struct gl_framebuffer *fb)
61 {
62    if (*ptr != fb)
63       _mesa_reference_framebuffer_(ptr, fb);
64 }
65 
66 extern void
67 _mesa_resize_framebuffer(struct gl_context *ctx, struct gl_framebuffer *fb,
68                          GLuint width, GLuint height);
69 
70 
71 extern void
72 _mesa_resizebuffers( struct gl_context *ctx );
73 
74 extern void
75 _mesa_intersect_scissor_bounding_box(const struct gl_context *ctx,
76                                      unsigned idx, int *bbox);
77 
78 static inline GLuint
_mesa_geometric_width(const struct gl_framebuffer * buffer)79 _mesa_geometric_width(const struct gl_framebuffer *buffer)
80 {
81    return buffer->_HasAttachments ?
82       buffer->Width : buffer->DefaultGeometry.Width;
83 }
84 
85 static inline GLuint
_mesa_geometric_height(const struct gl_framebuffer * buffer)86 _mesa_geometric_height(const struct gl_framebuffer *buffer)
87 {
88    return buffer->_HasAttachments ?
89       buffer->Height : buffer->DefaultGeometry.Height;
90 }
91 
92 static inline GLuint
_mesa_geometric_samples(const struct gl_framebuffer * buffer)93 _mesa_geometric_samples(const struct gl_framebuffer *buffer)
94 {
95    return buffer->_HasAttachments ?
96       buffer->Visual.samples :
97       buffer->DefaultGeometry._NumSamples;
98 }
99 
100 static inline GLuint
_mesa_geometric_layers(const struct gl_framebuffer * buffer)101 _mesa_geometric_layers(const struct gl_framebuffer *buffer)
102 {
103    return buffer->_HasAttachments ?
104       buffer->MaxNumLayers : buffer->DefaultGeometry.Layers;
105 }
106 
107 extern void
108 _mesa_update_draw_buffer_bounds(struct gl_context *ctx,
109                                 struct gl_framebuffer *drawFb);
110 
111 extern void
112 _mesa_update_framebuffer_visual(struct gl_context *ctx,
113 				struct gl_framebuffer *fb);
114 
115 extern void
116 _mesa_update_framebuffer(struct gl_context *ctx,
117                          struct gl_framebuffer *readFb,
118                          struct gl_framebuffer *drawFb);
119 
120 extern GLboolean
121 _mesa_source_buffer_exists(struct gl_context *ctx, GLenum format);
122 
123 extern GLboolean
124 _mesa_dest_buffer_exists(struct gl_context *ctx, GLenum format);
125 
126 extern GLenum
127 _mesa_get_color_read_type(struct gl_context *ctx,
128                           struct gl_framebuffer *fb,
129                           const char *caller);
130 
131 extern GLenum
132 _mesa_get_color_read_format(struct gl_context *ctx,
133                             struct gl_framebuffer *fb,
134                             const char *caller);
135 
136 extern struct gl_renderbuffer *
137 _mesa_get_read_renderbuffer_for_format(const struct gl_context *ctx,
138                                        GLenum format);
139 
140 extern void
141 _mesa_print_framebuffer(const struct gl_framebuffer *fb);
142 
143 extern bool
144 _mesa_is_front_buffer_reading(const struct gl_framebuffer *fb);
145 
146 extern bool
147 _mesa_is_front_buffer_drawing(const struct gl_framebuffer *fb);
148 
149 extern bool
150 _mesa_is_multisample_enabled(const struct gl_context *ctx);
151 
152 extern bool
153 _mesa_is_alpha_test_enabled(const struct gl_context *ctx);
154 
155 extern bool
156 _mesa_is_alpha_to_coverage_enabled(const struct gl_context *ctx);
157 
158 #endif /* FRAMEBUFFER_H */
159