1 /**************************************************************************
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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 TUNGSTEN GRAPHICS 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.
26 **************************************************************************/
31 * Screen, Adapter or GPU
33 * These are driver functions/facilities that are context independent.
41 #include "pipe/p_compiler.h"
42 #include "pipe/p_format.h"
43 #include "pipe/p_defines.h"
55 struct pipe_fence_handle
;
63 * Gallium screen/adapter context. Basically everything
64 * hardware-specific that doesn't actually require a rendering
68 struct pipe_winsys
*winsys
;
70 void (*destroy
)( struct pipe_screen
* );
73 const char *(*get_name
)( struct pipe_screen
* );
75 const char *(*get_vendor
)( struct pipe_screen
* );
78 * Query an integer-valued capability/parameter/limit
79 * \param param one of PIPE_CAP_x
81 int (*get_param
)( struct pipe_screen
*, enum pipe_cap param
);
84 * Query a float-valued capability/parameter/limit
85 * \param param one of PIPE_CAP_x
87 float (*get_paramf
)( struct pipe_screen
*, enum pipe_cap param
);
90 * Query a per-shader-stage integer-valued capability/parameter/limit
91 * \param param one of PIPE_CAP_x
93 int (*get_shader_param
)( struct pipe_screen
*, unsigned shader
, enum pipe_shader_cap param
);
96 * Query an integer-valued capability/parameter/limit for a codec/profile
97 * \param param one of PIPE_VIDEO_CAP_x
99 int (*get_video_param
)( struct pipe_screen
*, enum pipe_video_profile profile
, enum pipe_video_cap param
);
101 struct pipe_context
* (*context_create
)( struct pipe_screen
*, void *priv
);
103 struct pipe_video_context
* (*video_context_create
)( struct pipe_screen
*screen
, void *priv
);
106 * Check if the given pipe_format is supported as a texture or
108 * \param bindings bitmask of PIPE_BIND_*
110 boolean (*is_format_supported
)( struct pipe_screen
*,
111 enum pipe_format format
,
112 enum pipe_texture_target target
,
113 unsigned sample_count
,
117 * Create a new texture object, using the given template info.
119 struct pipe_resource
* (*resource_create
)(struct pipe_screen
*,
120 const struct pipe_resource
*templat
);
123 * Create a texture from a winsys_handle. The handle is often created in
124 * another process by first creating a pipe texture and then calling
125 * resource_get_handle.
127 struct pipe_resource
* (*resource_from_handle
)(struct pipe_screen
*,
128 const struct pipe_resource
*templat
,
129 struct winsys_handle
*handle
);
132 * Get a winsys_handle from a texture. Some platforms/winsys requires
133 * that the texture is created with a special usage flag like
134 * DISPLAYTARGET or PRIMARY.
136 boolean (*resource_get_handle
)(struct pipe_screen
*,
137 struct pipe_resource
*tex
,
138 struct winsys_handle
*handle
);
141 void (*resource_destroy
)(struct pipe_screen
*,
142 struct pipe_resource
*pt
);
146 * Create a buffer that wraps user-space data.
148 * Effectively this schedules a delayed call to buffer_create
149 * followed by an upload of the data at *some point in the future*,
150 * or perhaps never. Basically the allocate/upload is delayed
151 * until the buffer is actually passed to hardware.
153 * The intention is to provide a quick way to turn regular data
154 * into a buffer, and secondly to avoid a copy operation if that
155 * data subsequently turns out to be only accessed by the CPU.
157 * Common example is OpenGL vertex buffers that are subsequently
158 * processed either by software TNL in the driver or by passing to
161 * XXX: What happens if the delayed call to buffer_create() fails?
163 * Note that ptr may be accessed at any time upto the time when the
164 * buffer is destroyed, so the data must not be freed before then.
166 struct pipe_resource
*(*user_buffer_create
)(struct pipe_screen
*screen
,
169 unsigned bind_flags
);
172 * Do any special operations to ensure frontbuffer contents are
173 * displayed, eg copy fake frontbuffer.
174 * \param winsys_drawable_handle an opaque handle that the calling context
177 void (*flush_frontbuffer
)( struct pipe_screen
*screen
,
178 struct pipe_resource
*resource
,
179 unsigned level
, unsigned layer
,
180 void *winsys_drawable_handle
);
184 /** Set ptr = fence, with reference counting */
185 void (*fence_reference
)( struct pipe_screen
*screen
,
186 struct pipe_fence_handle
**ptr
,
187 struct pipe_fence_handle
*fence
);
190 * Checks whether the fence has been signalled.
192 boolean (*fence_signalled
)( struct pipe_screen
*screen
,
193 struct pipe_fence_handle
*fence
);
196 * Wait for the fence to finish.
197 * \param timeout in nanoseconds
199 boolean (*fence_finish
)( struct pipe_screen
*screen
,
200 struct pipe_fence_handle
*fence
,
210 #endif /* P_SCREEN_H */