p_screen.h revision d9d82dcd006c124e6569789c90390c43c1360c06
1aa59a937ccf41609081d3f9a4973df5478979785Brian/************************************************************************** 2a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König * 3aa59a937ccf41609081d3f9a4973df5478979785Brian * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas. 4aa59a937ccf41609081d3f9a4973df5478979785Brian * All Rights Reserved. 5a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König * 6aa59a937ccf41609081d3f9a4973df5478979785Brian * Permission is hereby granted, free of charge, to any person obtaining a 7aa59a937ccf41609081d3f9a4973df5478979785Brian * copy of this software and associated documentation files (the 8aa59a937ccf41609081d3f9a4973df5478979785Brian * "Software"), to deal in the Software without restriction, including 9aa59a937ccf41609081d3f9a4973df5478979785Brian * without limitation the rights to use, copy, modify, merge, publish, 10aa59a937ccf41609081d3f9a4973df5478979785Brian * distribute, sub license, and/or sell copies of the Software, and to 11aa59a937ccf41609081d3f9a4973df5478979785Brian * permit persons to whom the Software is furnished to do so, subject to 12aa59a937ccf41609081d3f9a4973df5478979785Brian * the following conditions: 13a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König * 14aa59a937ccf41609081d3f9a4973df5478979785Brian * The above copyright notice and this permission notice (including the 15aa59a937ccf41609081d3f9a4973df5478979785Brian * next paragraph) shall be included in all copies or substantial portions 16aa59a937ccf41609081d3f9a4973df5478979785Brian * of the Software. 17a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König * 18aa59a937ccf41609081d3f9a4973df5478979785Brian * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19aa59a937ccf41609081d3f9a4973df5478979785Brian * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20aa59a937ccf41609081d3f9a4973df5478979785Brian * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21aa59a937ccf41609081d3f9a4973df5478979785Brian * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR 22aa59a937ccf41609081d3f9a4973df5478979785Brian * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23aa59a937ccf41609081d3f9a4973df5478979785Brian * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24aa59a937ccf41609081d3f9a4973df5478979785Brian * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König * 26aa59a937ccf41609081d3f9a4973df5478979785Brian **************************************************************************/ 27aa59a937ccf41609081d3f9a4973df5478979785Brian 28aa59a937ccf41609081d3f9a4973df5478979785Brian/** 29984a7c4e9c42cf8ddfcff5b880b522a6dd58bce2José Fonseca * @file 30a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König * 31aa59a937ccf41609081d3f9a4973df5478979785Brian * Screen, Adapter or GPU 32aa59a937ccf41609081d3f9a4973df5478979785Brian * 33aa59a937ccf41609081d3f9a4973df5478979785Brian * These are driver functions/facilities that are context independent. 34aa59a937ccf41609081d3f9a4973df5478979785Brian */ 35aa59a937ccf41609081d3f9a4973df5478979785Brian 36aa59a937ccf41609081d3f9a4973df5478979785Brian 37aa59a937ccf41609081d3f9a4973df5478979785Brian#ifndef P_SCREEN_H 38aa59a937ccf41609081d3f9a4973df5478979785Brian#define P_SCREEN_H 39aa59a937ccf41609081d3f9a4973df5478979785Brian 40aa59a937ccf41609081d3f9a4973df5478979785Brian 41aa59a937ccf41609081d3f9a4973df5478979785Brian#include "pipe/p_compiler.h" 42099e9d20f0e8f5ee108e4fbb4bf7cae97b5f9a4aBrian Paul#include "pipe/p_format.h" 43099e9d20f0e8f5ee108e4fbb4bf7cae97b5f9a4aBrian Paul#include "pipe/p_defines.h" 44a5a942256162eb0ca4df2f8202a916b080396141Brian Paul#include "pipe/p_video_enums.h" 45aa59a937ccf41609081d3f9a4973df5478979785Brian 46aa59a937ccf41609081d3f9a4973df5478979785Brian 47aa59a937ccf41609081d3f9a4973df5478979785Brian 48aa59a937ccf41609081d3f9a4973df5478979785Brian#ifdef __cplusplus 49aa59a937ccf41609081d3f9a4973df5478979785Brianextern "C" { 50aa59a937ccf41609081d3f9a4973df5478979785Brian#endif 51aa59a937ccf41609081d3f9a4973df5478979785Brian 52aa59a937ccf41609081d3f9a4973df5478979785Brian 53adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin/** Opaque type */ 54b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantzstruct winsys_handle; 55b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz/** Opaque type */ 56adfbba476db1fc55006efb748656ebb1a481d143Zack Rusinstruct pipe_fence_handle; 57287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwellstruct pipe_resource; 58f547472bfa0a797adacc2a7688b4c1ba65381a80Younes Mantonstruct pipe_surface; 59f547472bfa0a797adacc2a7688b4c1ba65381a80Younes Mantonstruct pipe_transfer; 60aa59a937ccf41609081d3f9a4973df5478979785Brian 614617981ec72f7985941bee4b03c534d97ff96bc6Michel Dänzer 62aa59a937ccf41609081d3f9a4973df5478979785Brian/** 63aa59a937ccf41609081d3f9a4973df5478979785Brian * Gallium screen/adapter context. Basically everything 64aa59a937ccf41609081d3f9a4973df5478979785Brian * hardware-specific that doesn't actually require a rendering 65aa59a937ccf41609081d3f9a4973df5478979785Brian * context. 66aa59a937ccf41609081d3f9a4973df5478979785Brian */ 67aa59a937ccf41609081d3f9a4973df5478979785Brianstruct pipe_screen { 68aa59a937ccf41609081d3f9a4973df5478979785Brian void (*destroy)( struct pipe_screen * ); 69aa59a937ccf41609081d3f9a4973df5478979785Brian 70aa59a937ccf41609081d3f9a4973df5478979785Brian 71aa59a937ccf41609081d3f9a4973df5478979785Brian const char *(*get_name)( struct pipe_screen * ); 72aa59a937ccf41609081d3f9a4973df5478979785Brian 73aa59a937ccf41609081d3f9a4973df5478979785Brian const char *(*get_vendor)( struct pipe_screen * ); 74aa59a937ccf41609081d3f9a4973df5478979785Brian 75aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 76aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Query an integer-valued capability/parameter/limit 77aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * \param param one of PIPE_CAP_x 78aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 79e1238b5cad3845c029f60d92c08e810274517d33José Fonseca int (*get_param)( struct pipe_screen *, enum pipe_cap param ); 80aa59a937ccf41609081d3f9a4973df5478979785Brian 81aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 82aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Query a float-valued capability/parameter/limit 83aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * \param param one of PIPE_CAP_x 84aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 85bb71f9249a66b9a4921a878766c0a2d87624c369Marek Olšák float (*get_paramf)( struct pipe_screen *, enum pipe_capf param ); 86aa59a937ccf41609081d3f9a4973df5478979785Brian 87a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri /** 88a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri * Query a per-shader-stage integer-valued capability/parameter/limit 89a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri * \param param one of PIPE_CAP_x 90a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri */ 91a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri int (*get_shader_param)( struct pipe_screen *, unsigned shader, enum pipe_shader_cap param ); 92aa59a937ccf41609081d3f9a4973df5478979785Brian 93f265a194263bb2a3fa204947a9c98f472835f121Christian König /** 94f265a194263bb2a3fa204947a9c98f472835f121Christian König * Query an integer-valued capability/parameter/limit for a codec/profile 95f265a194263bb2a3fa204947a9c98f472835f121Christian König * \param param one of PIPE_VIDEO_CAP_x 96f265a194263bb2a3fa204947a9c98f472835f121Christian König */ 97a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König int (*get_video_param)( struct pipe_screen *, 98a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König enum pipe_video_profile profile, 99a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König enum pipe_video_cap param ); 100f265a194263bb2a3fa204947a9c98f472835f121Christian König 101d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez /** 102d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez * Query a compute-specific capability/parameter/limit. 103d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez * \param param one of PIPE_COMPUTE_CAP_x 104d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez * \param ret pointer to a preallocated buffer that will be 105d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez * initialized to the parameter value, or NULL. 106d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez * \return size in bytes of the parameter value that would be 107d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez * returned. 108d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez */ 109d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez int (*get_compute_param)(struct pipe_screen *, 110d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez enum pipe_compute_cap param, 111d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez void *ret); 112d9d82dcd006c124e6569789c90390c43c1360c06Francisco Jerez 113a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König struct pipe_context * (*context_create)( struct pipe_screen *, 114a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König void *priv ); 115f64d0cf524b2203e648a060366a2e4220096aa1fYounes Manton 116aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 117aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Check if the given pipe_format is supported as a texture or 118aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * drawing surface. 119d888812324719723de3256612886dd61de3bd282Brian Paul * \param bindings bitmask of PIPE_BIND_* 120aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 121aa59a937ccf41609081d3f9a4973df5478979785Brian boolean (*is_format_supported)( struct pipe_screen *, 1228aafc03b260ab8923f1b373f7effa75bcdb40a72José Fonseca enum pipe_format format, 1238aafc03b260ab8923f1b373f7effa75bcdb40a72José Fonseca enum pipe_texture_target target, 1246272d7632a8d2948e45698d1c75eae8c441c3916Roland Scheidegger unsigned sample_count, 125e968975cb57eb854769292f7c6ff773c64a386c3Marek Olšák unsigned bindings ); 126a7ec477ebc8b256381854f1cef0ec03a2d713555Christian König 1277eca76952b6726be9459375dde7478a01789577eChristian König /** 1287eca76952b6726be9459375dde7478a01789577eChristian König * Check if the given pipe_format is supported as output for this codec/profile. 1297eca76952b6726be9459375dde7478a01789577eChristian König * \param profile profile to check, may also be PIPE_VIDEO_PROFILE_UNKNOWN 1307eca76952b6726be9459375dde7478a01789577eChristian König */ 1317eca76952b6726be9459375dde7478a01789577eChristian König boolean (*is_video_format_supported)( struct pipe_screen *, 1327eca76952b6726be9459375dde7478a01789577eChristian König enum pipe_format format, 1337eca76952b6726be9459375dde7478a01789577eChristian König enum pipe_video_profile profile ); 134aa59a937ccf41609081d3f9a4973df5478979785Brian 135aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 136aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Create a new texture object, using the given template info. 137aa59a937ccf41609081d3f9a4973df5478979785Brian */ 138287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource * (*resource_create)(struct pipe_screen *, 139287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell const struct pipe_resource *templat); 140aa59a937ccf41609081d3f9a4973df5478979785Brian 1416361d6f48d13ce481253faf106fba5c6a41488edJosé Fonseca /** 142b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * Create a texture from a winsys_handle. The handle is often created in 143b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * another process by first creating a pipe texture and then calling 1444c7001462607e6e99e474d6271dd481d3f8f201cRoland Scheidegger * resource_get_handle. 1456361d6f48d13ce481253faf106fba5c6a41488edJosé Fonseca */ 146287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource * (*resource_from_handle)(struct pipe_screen *, 147287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell const struct pipe_resource *templat, 148287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct winsys_handle *handle); 149b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz 150b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz /** 151b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * Get a winsys_handle from a texture. Some platforms/winsys requires 152b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * that the texture is created with a special usage flag like 153b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * DISPLAYTARGET or PRIMARY. 154b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz */ 155287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell boolean (*resource_get_handle)(struct pipe_screen *, 156287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *tex, 157287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct winsys_handle *handle); 158b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz 1596361d6f48d13ce481253faf106fba5c6a41488edJosé Fonseca 160287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell void (*resource_destroy)(struct pipe_screen *, 161287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *pt); 162aa59a937ccf41609081d3f9a4973df5478979785Brian 163b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin 164b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin /** 165b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Create a buffer that wraps user-space data. 166b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 167b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Effectively this schedules a delayed call to buffer_create 168b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * followed by an upload of the data at *some point in the future*, 169b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * or perhaps never. Basically the allocate/upload is delayed 170b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * until the buffer is actually passed to hardware. 171b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 172b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * The intention is to provide a quick way to turn regular data 173b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * into a buffer, and secondly to avoid a copy operation if that 174b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * data subsequently turns out to be only accessed by the CPU. 175b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 176b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Common example is OpenGL vertex buffers that are subsequently 177b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * processed either by software TNL in the driver or by passing to 178b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * hardware. 179b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 180b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * XXX: What happens if the delayed call to buffer_create() fails? 181b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 182b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Note that ptr may be accessed at any time upto the time when the 183b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * buffer is destroyed, so the data must not be freed before then. 184b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin */ 185287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *(*user_buffer_create)(struct pipe_screen *screen, 186287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell void *ptr, 187287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell unsigned bytes, 188287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell unsigned bind_flags); 189adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 190adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** 191adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Do any special operations to ensure frontbuffer contents are 192adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * displayed, eg copy fake frontbuffer. 193e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu * \param winsys_drawable_handle an opaque handle that the calling context 194e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu * gets out-of-band 195adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 196adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin void (*flush_frontbuffer)( struct pipe_screen *screen, 1974c7001462607e6e99e474d6271dd481d3f8f201cRoland Scheidegger struct pipe_resource *resource, 1984c7001462607e6e99e474d6271dd481d3f8f201cRoland Scheidegger unsigned level, unsigned layer, 199e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu void *winsys_drawable_handle ); 200adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 201adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 202adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 203adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** Set ptr = fence, with reference counting */ 204adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin void (*fence_reference)( struct pipe_screen *screen, 205adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle **ptr, 206adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle *fence ); 207adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 208adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** 209adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Checks whether the fence has been signalled. 210adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 211bfe88e69988b3d3bdff0b9f6051d0428e1315653Marek Olšák boolean (*fence_signalled)( struct pipe_screen *screen, 212bfe88e69988b3d3bdff0b9f6051d0428e1315653Marek Olšák struct pipe_fence_handle *fence ); 213adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 214adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** 215adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Wait for the fence to finish. 216b39bccbd4ed71e9585da4cf5acf7b887b2e90899Marek Olšák * \param timeout in nanoseconds 217adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 218bfe88e69988b3d3bdff0b9f6051d0428e1315653Marek Olšák boolean (*fence_finish)( struct pipe_screen *screen, 219bfe88e69988b3d3bdff0b9f6051d0428e1315653Marek Olšák struct pipe_fence_handle *fence, 220bfe88e69988b3d3bdff0b9f6051d0428e1315653Marek Olšák uint64_t timeout ); 221adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 222aa59a937ccf41609081d3f9a4973df5478979785Brian}; 223aa59a937ccf41609081d3f9a4973df5478979785Brian 224aa59a937ccf41609081d3f9a4973df5478979785Brian 225aa59a937ccf41609081d3f9a4973df5478979785Brian#ifdef __cplusplus 226aa59a937ccf41609081d3f9a4973df5478979785Brian} 227aa59a937ccf41609081d3f9a4973df5478979785Brian#endif 228aa59a937ccf41609081d3f9a4973df5478979785Brian 229aa59a937ccf41609081d3f9a4973df5478979785Brian#endif /* P_SCREEN_H */ 230