p_screen.h revision b39bccbd4ed71e9585da4cf5acf7b887b2e90899
1aa59a937ccf41609081d3f9a4973df5478979785Brian/************************************************************************** 2aa59a937ccf41609081d3f9a4973df5478979785Brian * 3aa59a937ccf41609081d3f9a4973df5478979785Brian * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas. 4aa59a937ccf41609081d3f9a4973df5478979785Brian * All Rights Reserved. 5aa59a937ccf41609081d3f9a4973df5478979785Brian * 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: 13aa59a937ccf41609081d3f9a4973df5478979785Brian * 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. 17aa59a937ccf41609081d3f9a4973df5478979785Brian * 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. 25aa59a937ccf41609081d3f9a4973df5478979785Brian * 26aa59a937ccf41609081d3f9a4973df5478979785Brian **************************************************************************/ 27aa59a937ccf41609081d3f9a4973df5478979785Brian 28aa59a937ccf41609081d3f9a4973df5478979785Brian/** 29984a7c4e9c42cf8ddfcff5b880b522a6dd58bce2José Fonseca * @file 30984a7c4e9c42cf8ddfcff5b880b522a6dd58bce2José Fonseca * 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" 44aa59a937ccf41609081d3f9a4973df5478979785Brian 45aa59a937ccf41609081d3f9a4973df5478979785Brian 46aa59a937ccf41609081d3f9a4973df5478979785Brian 47aa59a937ccf41609081d3f9a4973df5478979785Brian#ifdef __cplusplus 48aa59a937ccf41609081d3f9a4973df5478979785Brianextern "C" { 49aa59a937ccf41609081d3f9a4973df5478979785Brian#endif 50aa59a937ccf41609081d3f9a4973df5478979785Brian 51aa59a937ccf41609081d3f9a4973df5478979785Brian 52adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin/** Opaque type */ 53b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantzstruct winsys_handle; 54b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz/** Opaque type */ 55adfbba476db1fc55006efb748656ebb1a481d143Zack Rusinstruct pipe_fence_handle; 560703b2e9ad9ef9d05f7ba53b93dba780ad34b47dBrian Paulstruct pipe_winsys; 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 struct pipe_winsys *winsys; 69aa59a937ccf41609081d3f9a4973df5478979785Brian 70aa59a937ccf41609081d3f9a4973df5478979785Brian void (*destroy)( struct pipe_screen * ); 71aa59a937ccf41609081d3f9a4973df5478979785Brian 72aa59a937ccf41609081d3f9a4973df5478979785Brian 73aa59a937ccf41609081d3f9a4973df5478979785Brian const char *(*get_name)( struct pipe_screen * ); 74aa59a937ccf41609081d3f9a4973df5478979785Brian 75aa59a937ccf41609081d3f9a4973df5478979785Brian const char *(*get_vendor)( struct pipe_screen * ); 76aa59a937ccf41609081d3f9a4973df5478979785Brian 77aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 78aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Query an integer-valued capability/parameter/limit 79aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * \param param one of PIPE_CAP_x 80aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 81e1238b5cad3845c029f60d92c08e810274517d33José Fonseca int (*get_param)( struct pipe_screen *, enum pipe_cap param ); 82aa59a937ccf41609081d3f9a4973df5478979785Brian 83aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 84aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Query a float-valued capability/parameter/limit 85aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * \param param one of PIPE_CAP_x 86aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 87e1238b5cad3845c029f60d92c08e810274517d33José Fonseca float (*get_paramf)( struct pipe_screen *, enum pipe_cap param ); 88aa59a937ccf41609081d3f9a4973df5478979785Brian 89a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri /** 90a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri * Query a per-shader-stage integer-valued capability/parameter/limit 91a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri * \param param one of PIPE_CAP_x 92a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri */ 93a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri int (*get_shader_param)( struct pipe_screen *, unsigned shader, enum pipe_shader_cap param ); 94a508d2dddcc67d0f92cc36b9ed6f36a9bbfc579dLuca Barbieri 957f41f5447c8f9113c8956901e1c5fff6081ecd94Keith Whitwell struct pipe_context * (*context_create)( struct pipe_screen *, 967f41f5447c8f9113c8956901e1c5fff6081ecd94Keith Whitwell void *priv ); 976272d7632a8d2948e45698d1c75eae8c441c3916Roland Scheidegger 98aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 99aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Check if the given pipe_format is supported as a texture or 100aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * drawing surface. 101d888812324719723de3256612886dd61de3bd282Brian Paul * \param bindings bitmask of PIPE_BIND_* 102985e71866a9eb4c6f18ff8766eb278e58bf09830Brian Paul * \param geom_flags bitmask of PIPE_TEXTURE_GEOM_* 103aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 104aa59a937ccf41609081d3f9a4973df5478979785Brian boolean (*is_format_supported)( struct pipe_screen *, 1058aafc03b260ab8923f1b373f7effa75bcdb40a72José Fonseca enum pipe_format format, 1068aafc03b260ab8923f1b373f7effa75bcdb40a72José Fonseca enum pipe_texture_target target, 1076272d7632a8d2948e45698d1c75eae8c441c3916Roland Scheidegger unsigned sample_count, 108aac2cccccfd701ae8d7ce0813c28c64498d4a076Roland Scheidegger unsigned bindings, 1098aafc03b260ab8923f1b373f7effa75bcdb40a72José Fonseca unsigned geom_flags ); 110aa59a937ccf41609081d3f9a4973df5478979785Brian 111aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 112aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Create a new texture object, using the given template info. 113aa59a937ccf41609081d3f9a4973df5478979785Brian */ 114287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource * (*resource_create)(struct pipe_screen *, 115287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell const struct pipe_resource *templat); 116aa59a937ccf41609081d3f9a4973df5478979785Brian 1176361d6f48d13ce481253faf106fba5c6a41488edJosé Fonseca /** 118b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * Create a texture from a winsys_handle. The handle is often created in 119b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * another process by first creating a pipe texture and then calling 1204c7001462607e6e99e474d6271dd481d3f8f201cRoland Scheidegger * resource_get_handle. 121b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz */ 122287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource * (*resource_from_handle)(struct pipe_screen *, 123287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell const struct pipe_resource *templat, 124287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct winsys_handle *handle); 125b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz 126b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz /** 127b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * Get a winsys_handle from a texture. Some platforms/winsys requires 128b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * that the texture is created with a special usage flag like 129b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * DISPLAYTARGET or PRIMARY. 130b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz */ 131287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell boolean (*resource_get_handle)(struct pipe_screen *, 132287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *tex, 133287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct winsys_handle *handle); 134b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz 1356361d6f48d13ce481253faf106fba5c6a41488edJosé Fonseca 136287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell void (*resource_destroy)(struct pipe_screen *, 137287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *pt); 138aa59a937ccf41609081d3f9a4973df5478979785Brian 139b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin 140b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin /** 141b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Create a buffer that wraps user-space data. 142b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 143b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Effectively this schedules a delayed call to buffer_create 144b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * followed by an upload of the data at *some point in the future*, 145b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * or perhaps never. Basically the allocate/upload is delayed 146b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * until the buffer is actually passed to hardware. 147b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 148b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * The intention is to provide a quick way to turn regular data 149b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * into a buffer, and secondly to avoid a copy operation if that 150b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * data subsequently turns out to be only accessed by the CPU. 151b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 152b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Common example is OpenGL vertex buffers that are subsequently 153b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * processed either by software TNL in the driver or by passing to 154b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * hardware. 155b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 156b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * XXX: What happens if the delayed call to buffer_create() fails? 157b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 158b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Note that ptr may be accessed at any time upto the time when the 159b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * buffer is destroyed, so the data must not be freed before then. 160b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin */ 161287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *(*user_buffer_create)(struct pipe_screen *screen, 162287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell void *ptr, 163287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell unsigned bytes, 164287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell unsigned bind_flags); 165f547472bfa0a797adacc2a7688b4c1ba65381a80Younes Manton 16632da02f7c19f49802fe9589e73c3945502a197c9Ben Skeggs /** 167adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Do any special operations to ensure frontbuffer contents are 168adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * displayed, eg copy fake frontbuffer. 169e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu * \param winsys_drawable_handle an opaque handle that the calling context 170e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu * gets out-of-band 171adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 172adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin void (*flush_frontbuffer)( struct pipe_screen *screen, 1734c7001462607e6e99e474d6271dd481d3f8f201cRoland Scheidegger struct pipe_resource *resource, 1744c7001462607e6e99e474d6271dd481d3f8f201cRoland Scheidegger unsigned level, unsigned layer, 175e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu void *winsys_drawable_handle ); 176adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 177adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 178adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 179adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** Set ptr = fence, with reference counting */ 180adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin void (*fence_reference)( struct pipe_screen *screen, 181adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle **ptr, 182adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle *fence ); 183adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 184adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** 185adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Checks whether the fence has been signalled. 186adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * \param flags driver-specific meaning 187adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * \return zero on success. 188adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 189adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin int (*fence_signalled)( struct pipe_screen *screen, 190adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle *fence, 1917ea265888f19bcbc1771f6c671ce08855b80bf0aJosé Fonseca unsigned flags ); 192adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 193adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** 194adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Wait for the fence to finish. 195adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * \param flags driver-specific meaning 196b39bccbd4ed71e9585da4cf5acf7b887b2e90899Marek Olšák * \param timeout in nanoseconds 197adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * \return zero on success. 198adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 199adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin int (*fence_finish)( struct pipe_screen *screen, 200adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle *fence, 201b39bccbd4ed71e9585da4cf5acf7b887b2e90899Marek Olšák unsigned flags, 202b39bccbd4ed71e9585da4cf5acf7b887b2e90899Marek Olšák uint64_t timeout ); 203adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 204aa59a937ccf41609081d3f9a4973df5478979785Brian}; 205aa59a937ccf41609081d3f9a4973df5478979785Brian 206aa59a937ccf41609081d3f9a4973df5478979785Brian 207aa59a937ccf41609081d3f9a4973df5478979785Brian#ifdef __cplusplus 208aa59a937ccf41609081d3f9a4973df5478979785Brian} 209aa59a937ccf41609081d3f9a4973df5478979785Brian#endif 210aa59a937ccf41609081d3f9a4973df5478979785Brian 211aa59a937ccf41609081d3f9a4973df5478979785Brian#endif /* P_SCREEN_H */ 212