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