1 /**************************************************************************
3 * Copyright 2007 VMware, Inc.
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 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.
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"
44 #include "pipe/p_video_enums.h"
55 struct pipe_fence_handle
;
60 struct pipe_memory_info
;
65 * Gallium screen/adapter context. Basically everything
66 * hardware-specific that doesn't actually require a rendering
70 void (*destroy
)( struct pipe_screen
* );
72 const char *(*get_name
)( struct pipe_screen
* );
74 const char *(*get_vendor
)( struct pipe_screen
* );
77 * Returns the device vendor.
79 * The returned value should return the actual device vendor/manufacturer,
80 * rather than a potentially generic driver string.
82 const char *(*get_device_vendor
)( struct pipe_screen
* );
85 * Query an integer-valued capability/parameter/limit
86 * \param param one of PIPE_CAP_x
88 int (*get_param
)( struct pipe_screen
*, enum pipe_cap param
);
91 * Query a float-valued capability/parameter/limit
92 * \param param one of PIPE_CAP_x
94 float (*get_paramf
)( struct pipe_screen
*, enum pipe_capf param
);
97 * Query a per-shader-stage integer-valued capability/parameter/limit
98 * \param param one of PIPE_CAP_x
100 int (*get_shader_param
)( struct pipe_screen
*, enum pipe_shader_type shader
,
101 enum pipe_shader_cap param
);
104 * Query an integer-valued capability/parameter/limit for a codec/profile
105 * \param param one of PIPE_VIDEO_CAP_x
107 int (*get_video_param
)( struct pipe_screen
*,
108 enum pipe_video_profile profile
,
109 enum pipe_video_entrypoint entrypoint
,
110 enum pipe_video_cap param
);
113 * Query a compute-specific capability/parameter/limit.
114 * \param ir_type shader IR type for which the param applies, or don't care
115 * if the param is not shader related
116 * \param param one of PIPE_COMPUTE_CAP_x
117 * \param ret pointer to a preallocated buffer that will be
118 * initialized to the parameter value, or NULL.
119 * \return size in bytes of the parameter value that would be
122 int (*get_compute_param
)(struct pipe_screen
*,
123 enum pipe_shader_ir ir_type
,
124 enum pipe_compute_cap param
,
128 * Query a timestamp in nanoseconds. The returned value should match
129 * PIPE_QUERY_TIMESTAMP. This function returns immediately and doesn't
130 * wait for rendering to complete (which cannot be achieved with queries).
132 uint64_t (*get_timestamp
)(struct pipe_screen
*);
137 * \param screen pipe screen
138 * \param priv a pointer to set in pipe_context::priv
139 * \param flags a mask of PIPE_CONTEXT_* flags
141 struct pipe_context
* (*context_create
)(struct pipe_screen
*screen
,
142 void *priv
, unsigned flags
);
145 * Check if the given pipe_format is supported as a texture or
147 * \param bindings bitmask of PIPE_BIND_*
149 boolean (*is_format_supported
)( struct pipe_screen
*,
150 enum pipe_format format
,
151 enum pipe_texture_target target
,
152 unsigned sample_count
,
156 * Check if the given pipe_format is supported as output for this codec/profile.
157 * \param profile profile to check, may also be PIPE_VIDEO_PROFILE_UNKNOWN
159 boolean (*is_video_format_supported
)( struct pipe_screen
*,
160 enum pipe_format format
,
161 enum pipe_video_profile profile
,
162 enum pipe_video_entrypoint entrypoint
);
165 * Check if we can actually create the given resource (test the dimension,
166 * overall size, etc). Used to implement proxy textures.
167 * \return TRUE if size is OK, FALSE if too large.
169 boolean (*can_create_resource
)(struct pipe_screen
*screen
,
170 const struct pipe_resource
*templat
);
173 * Create a new texture object, using the given template info.
175 struct pipe_resource
* (*resource_create
)(struct pipe_screen
*,
176 const struct pipe_resource
*templat
);
178 struct pipe_resource
* (*resource_create_front
)(struct pipe_screen
*,
179 const struct pipe_resource
*templat
,
180 const void *map_front_private
);
183 * Create a texture from a winsys_handle. The handle is often created in
184 * another process by first creating a pipe texture and then calling
185 * resource_get_handle.
187 * NOTE: in the case of DRM_API_HANDLE_TYPE_FD handles, the caller
188 * retains ownership of the FD. (This is consistent with
189 * EGL_EXT_image_dma_buf_import)
191 * \param usage A combination of PIPE_HANDLE_USAGE_* flags.
193 struct pipe_resource
* (*resource_from_handle
)(struct pipe_screen
*,
194 const struct pipe_resource
*templat
,
195 struct winsys_handle
*handle
,
199 * Create a resource from user memory. This maps the user memory into
200 * the device address space.
202 struct pipe_resource
* (*resource_from_user_memory
)(struct pipe_screen
*,
203 const struct pipe_resource
*t
,
207 * Get a winsys_handle from a texture. Some platforms/winsys requires
208 * that the texture is created with a special usage flag like
209 * DISPLAYTARGET or PRIMARY.
211 * The context parameter can optionally be used to flush the resource and
212 * the context to make sure the resource is coherent with whatever user
213 * will use it. Some drivers may also use the context to convert
214 * the resource into a format compatible for sharing. The use case is
215 * OpenGL-OpenCL interop. The context parameter is allowed to be NULL.
217 * NOTE: in the case of DRM_API_HANDLE_TYPE_FD handles, the caller
218 * takes ownership of the FD. (This is consistent with
219 * EGL_MESA_image_dma_buf_export)
221 * \param usage A combination of PIPE_HANDLE_USAGE_* flags.
223 boolean (*resource_get_handle
)(struct pipe_screen
*,
224 struct pipe_context
*context
,
225 struct pipe_resource
*tex
,
226 struct winsys_handle
*handle
,
230 * Mark the resource as changed so derived internal resources will be
231 * recreated on next use.
233 * This is necessary when reimporting external images that can't be directly
234 * used as texture sampler source, to avoid sampling from old copies.
236 void (*resource_changed
)(struct pipe_screen
*, struct pipe_resource
*pt
);
238 void (*resource_destroy
)(struct pipe_screen
*,
239 struct pipe_resource
*pt
);
243 * Do any special operations to ensure frontbuffer contents are
244 * displayed, eg copy fake frontbuffer.
245 * \param winsys_drawable_handle an opaque handle that the calling context
247 * \param subbox an optional sub region to flush
249 void (*flush_frontbuffer
)( struct pipe_screen
*screen
,
250 struct pipe_resource
*resource
,
251 unsigned level
, unsigned layer
,
252 void *winsys_drawable_handle
,
253 struct pipe_box
*subbox
);
255 /** Set ptr = fence, with reference counting */
256 void (*fence_reference
)( struct pipe_screen
*screen
,
257 struct pipe_fence_handle
**ptr
,
258 struct pipe_fence_handle
*fence
);
261 * Wait for the fence to finish.
263 * If the fence was created with PIPE_FLUSH_DEFERRED, and the context is
264 * still unflushed, and the ctx parameter of fence_finish is equal to
265 * the context where the fence was created, fence_finish will flush
266 * the context prior to waiting for the fence.
268 * In all other cases, the ctx parameter has no effect.
270 * \param timeout in nanoseconds (may be PIPE_TIMEOUT_INFINITE).
272 boolean (*fence_finish
)(struct pipe_screen
*screen
,
273 struct pipe_context
*ctx
,
274 struct pipe_fence_handle
*fence
,
278 * For fences created with PIPE_FLUSH_FENCE_FD (exported fd) or
279 * by create_fence_fd() (imported fd), return the native fence fd
280 * associated with the fence. This may return -1 for fences
281 * created with PIPE_FLUSH_DEFERRED if the fence command has not
284 int (*fence_get_fd
)(struct pipe_screen
*screen
,
285 struct pipe_fence_handle
*fence
);
288 * Returns a driver-specific query.
290 * If \p info is NULL, the number of available queries is returned.
291 * Otherwise, the driver query at the specified \p index is returned
292 * in \p info. The function returns non-zero on success.
294 int (*get_driver_query_info
)(struct pipe_screen
*screen
,
296 struct pipe_driver_query_info
*info
);
299 * Returns a driver-specific query group.
301 * If \p info is NULL, the number of available groups is returned.
302 * Otherwise, the driver query group at the specified \p index is returned
303 * in \p info. The function returns non-zero on success.
305 int (*get_driver_query_group_info
)(struct pipe_screen
*screen
,
307 struct pipe_driver_query_group_info
*info
);
310 * Query information about memory usage.
312 void (*query_memory_info
)(struct pipe_screen
*screen
,
313 struct pipe_memory_info
*info
);
316 * Get IR specific compiler options struct. For PIPE_SHADER_IR_NIR this
317 * returns a 'struct nir_shader_compiler_options'. Drivers reporting
318 * NIR as the preferred IR must implement this.
320 const void *(*get_compiler_options
)(struct pipe_screen
*screen
,
321 enum pipe_shader_ir ir
,
322 enum pipe_shader_type shader
);
325 * Returns a pointer to a driver-specific on-disk shader cache. If the
326 * driver failed to create the cache or does not support an on-disk shader
327 * cache NULL is returned. The callback itself may also be NULL if the
328 * driver doesn't support an on-disk shader cache.
330 struct disk_cache
*(*get_disk_shader_cache
)(struct pipe_screen
*screen
);
333 * Create a new texture object from the given template info, taking
334 * format modifiers into account. \p modifiers specifies a list of format
335 * modifier tokens, as defined in drm_fourcc.h. The driver then picks the
336 * best modifier among these and creates the resource. \p count must
337 * contain the size of \p modifiers array.
339 * Returns NULL if an entry in \p modifiers is unsupported by the driver,
340 * or if only DRM_FORMAT_MOD_INVALID is provided.
342 struct pipe_resource
* (*resource_create_with_modifiers
)(
343 struct pipe_screen
*,
344 const struct pipe_resource
*templat
,
345 const uint64_t *modifiers
, int count
);
348 * Get supported modifiers for a format.
349 * If \p max is 0, the total number of supported modifiers for the supplied
350 * format is returned in \p count, with no modification to \p modifiers.
351 * Otherwise, \p modifiers is filled with upto \p max supported modifier
352 * codes, and \p count with the number of modifiers copied.
353 * The \p external_only array is used to return whether the format and
354 * modifier combination can only be used with an external texture target.
356 void (*query_dmabuf_modifiers
)(struct pipe_screen
*screen
,
357 enum pipe_format format
, int max
,
359 unsigned int *external_only
, int *count
);
367 #endif /* P_SCREEN_H */