st/mesa: move duplicated st_ws_framebuffer() function into header file
[mesa.git] / src / mesa / state_tracker / st_cb_fbo.h
1 /**************************************************************************
2 *
3 * Copyright 2007 VMware, Inc.
4 * 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
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28
29 #ifndef ST_CB_FBO_H
30 #define ST_CB_FBO_H
31
32 #include "main/compiler.h"
33 #include "main/fbobject.h"
34 #include "main/glheader.h"
35 #include "main/mtypes.h"
36
37 #include "pipe/p_compiler.h"
38 #include "pipe/p_format.h"
39
40 struct dd_function_table;
41 struct pipe_context;
42
43 /**
44 * Derived renderbuffer class. Just need to add a pointer to the
45 * pipe surface.
46 */
47 struct st_renderbuffer
48 {
49 struct gl_renderbuffer Base;
50 struct pipe_resource *texture;
51 struct pipe_surface *surface; /* temporary view into texture */
52 GLboolean defined; /**< defined contents? */
53
54 struct pipe_transfer *transfer; /**< only used when mapping the resource */
55
56 /**
57 * Used only when hardware accumulation buffers are not supported.
58 */
59 boolean software;
60 void *data;
61
62 bool use_readpix_cache;
63
64 /* Inputs from Driver.RenderTexture, don't use directly. */
65 boolean is_rtt; /**< whether Driver.RenderTexture was called */
66 unsigned rtt_face, rtt_slice;
67 boolean rtt_layered; /**< whether glFramebufferTexture was called */
68 };
69
70
71 static inline struct st_renderbuffer *
72 st_renderbuffer(struct gl_renderbuffer *rb)
73 {
74 return (struct st_renderbuffer *) rb;
75 }
76
77
78 /**
79 * Cast wrapper to convert a struct gl_framebuffer to an st_framebuffer.
80 * Return NULL if the struct gl_framebuffer is a user-created framebuffer.
81 * We'll only return non-null for window system framebuffers.
82 * Note that this function may fail.
83 */
84 static inline struct st_framebuffer *
85 st_ws_framebuffer(struct gl_framebuffer *fb)
86 {
87 /* FBO cannot be casted. See st_new_framebuffer */
88 if (fb && _mesa_is_winsys_fbo(fb))
89 return (struct st_framebuffer *) fb;
90 return NULL;
91 }
92
93
94 extern struct gl_renderbuffer *
95 st_new_renderbuffer_fb(enum pipe_format format, int samples, boolean sw);
96
97 extern void
98 st_update_renderbuffer_surface(struct st_context *st,
99 struct st_renderbuffer *strb);
100
101 extern void
102 st_init_fbo_functions(struct dd_function_table *functions);
103
104 #endif /* ST_CB_FBO_H */