p_screen.h revision e1238b5cad3845c029f60d92c08e810274517d33
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; 57f547472bfa0a797adacc2a7688b4c1ba65381a80Younes Mantonstruct pipe_texture; 58287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwellstruct pipe_resource; 59f547472bfa0a797adacc2a7688b4c1ba65381a80Younes Mantonstruct pipe_surface; 60f547472bfa0a797adacc2a7688b4c1ba65381a80Younes Mantonstruct pipe_transfer; 61aa59a937ccf41609081d3f9a4973df5478979785Brian 624617981ec72f7985941bee4b03c534d97ff96bc6Michel Dänzer 63aa59a937ccf41609081d3f9a4973df5478979785Brian/** 64aa59a937ccf41609081d3f9a4973df5478979785Brian * Gallium screen/adapter context. Basically everything 65aa59a937ccf41609081d3f9a4973df5478979785Brian * hardware-specific that doesn't actually require a rendering 66aa59a937ccf41609081d3f9a4973df5478979785Brian * context. 67aa59a937ccf41609081d3f9a4973df5478979785Brian */ 68aa59a937ccf41609081d3f9a4973df5478979785Brianstruct pipe_screen { 69aa59a937ccf41609081d3f9a4973df5478979785Brian struct pipe_winsys *winsys; 70aa59a937ccf41609081d3f9a4973df5478979785Brian 71aa59a937ccf41609081d3f9a4973df5478979785Brian void (*destroy)( struct pipe_screen * ); 72aa59a937ccf41609081d3f9a4973df5478979785Brian 73aa59a937ccf41609081d3f9a4973df5478979785Brian 74aa59a937ccf41609081d3f9a4973df5478979785Brian const char *(*get_name)( struct pipe_screen * ); 75aa59a937ccf41609081d3f9a4973df5478979785Brian 76aa59a937ccf41609081d3f9a4973df5478979785Brian const char *(*get_vendor)( struct pipe_screen * ); 77aa59a937ccf41609081d3f9a4973df5478979785Brian 78aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 79aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Query an integer-valued capability/parameter/limit 80aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * \param param one of PIPE_CAP_x 81aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 82e1238b5cad3845c029f60d92c08e810274517d33José Fonseca int (*get_param)( struct pipe_screen *, enum pipe_cap param ); 83aa59a937ccf41609081d3f9a4973df5478979785Brian 84aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 85aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Query a float-valued capability/parameter/limit 86aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * \param param one of PIPE_CAP_x 87aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 88e1238b5cad3845c029f60d92c08e810274517d33José Fonseca float (*get_paramf)( struct pipe_screen *, enum pipe_cap param ); 89aa59a937ccf41609081d3f9a4973df5478979785Brian 907f41f5447c8f9113c8956901e1c5fff6081ecd94Keith Whitwell struct pipe_context * (*context_create)( struct pipe_screen *, 917f41f5447c8f9113c8956901e1c5fff6081ecd94Keith Whitwell void *priv ); 927f41f5447c8f9113c8956901e1c5fff6081ecd94Keith Whitwell 93aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 94aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Check if the given pipe_format is supported as a texture or 95aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * drawing surface. 96d888812324719723de3256612886dd61de3bd282Brian Paul * \param bindings bitmask of PIPE_BIND_* 97985e71866a9eb4c6f18ff8766eb278e58bf09830Brian Paul * \param geom_flags bitmask of PIPE_TEXTURE_GEOM_* 98aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul */ 99aa59a937ccf41609081d3f9a4973df5478979785Brian boolean (*is_format_supported)( struct pipe_screen *, 1008aafc03b260ab8923f1b373f7effa75bcdb40a72José Fonseca enum pipe_format format, 1018aafc03b260ab8923f1b373f7effa75bcdb40a72José Fonseca enum pipe_texture_target target, 102d888812324719723de3256612886dd61de3bd282Brian Paul unsigned bindings, 1038aafc03b260ab8923f1b373f7effa75bcdb40a72José Fonseca unsigned geom_flags ); 104aa59a937ccf41609081d3f9a4973df5478979785Brian 105aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul /** 106aad9dd14d8ef44e55f70b639765dae89e9976345Brian Paul * Create a new texture object, using the given template info. 107aa59a937ccf41609081d3f9a4973df5478979785Brian */ 108287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource * (*resource_create)(struct pipe_screen *, 109287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell const struct pipe_resource *templat); 110aa59a937ccf41609081d3f9a4973df5478979785Brian 1116361d6f48d13ce481253faf106fba5c6a41488edJosé Fonseca /** 112b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * Create a texture from a winsys_handle. The handle is often created in 113b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * another process by first creating a pipe texture and then calling 114b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * texture_get_handle. 115b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz */ 116287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource * (*resource_from_handle)(struct pipe_screen *, 117287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell const struct pipe_resource *templat, 118287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct winsys_handle *handle); 119b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz 120b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz /** 121b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * Get a winsys_handle from a texture. Some platforms/winsys requires 122b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * that the texture is created with a special usage flag like 123b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz * DISPLAYTARGET or PRIMARY. 124b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz */ 125287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell boolean (*resource_get_handle)(struct pipe_screen *, 126287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *tex, 127287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct winsys_handle *handle); 128b2e94d05c9602e2814a513a51eed67d014b338f3Jakob Bornecrantz 1296361d6f48d13ce481253faf106fba5c6a41488edJosé Fonseca 130287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell void (*resource_destroy)(struct pipe_screen *, 131287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *pt); 132aa59a937ccf41609081d3f9a4973df5478979785Brian 1339f6990120ace5725e16ee2dd9a59da76fe1041ccBrian Paul /** Get a 2D surface which is a "view" into a texture 134287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell * \param usage bitmaks of PIPE_BIND_* flags 1359f6990120ace5725e16ee2dd9a59da76fe1041ccBrian Paul */ 136aa59a937ccf41609081d3f9a4973df5478979785Brian struct pipe_surface *(*get_tex_surface)(struct pipe_screen *, 137287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *resource, 138aa59a937ccf41609081d3f9a4973df5478979785Brian unsigned face, unsigned level, 139c9ed86a96483063f3d6789ed16645a3dca77d726Keith Whitwell unsigned zslice, 140c9ed86a96483063f3d6789ed16645a3dca77d726Keith Whitwell unsigned usage ); 141c9ed86a96483063f3d6789ed16645a3dca77d726Keith Whitwell 1425e27cd46c04a9e7b5904cc014bffd0f4daae31feMichel Dänzer void (*tex_surface_destroy)(struct pipe_surface *); 143c9ed86a96483063f3d6789ed16645a3dca77d726Keith Whitwell 144c9ed86a96483063f3d6789ed16645a3dca77d726Keith Whitwell 145b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin 146b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin /** 147b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Create a buffer that wraps user-space data. 148b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 149b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Effectively this schedules a delayed call to buffer_create 150b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * followed by an upload of the data at *some point in the future*, 151b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * or perhaps never. Basically the allocate/upload is delayed 152b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * until the buffer is actually passed to hardware. 153b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 154b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * The intention is to provide a quick way to turn regular data 155b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * into a buffer, and secondly to avoid a copy operation if that 156b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * data subsequently turns out to be only accessed by the CPU. 157b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 158b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Common example is OpenGL vertex buffers that are subsequently 159b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * processed either by software TNL in the driver or by passing to 160b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * hardware. 161b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 162b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * XXX: What happens if the delayed call to buffer_create() fails? 163b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * 164b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * Note that ptr may be accessed at any time upto the time when the 165b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin * buffer is destroyed, so the data must not be freed before then. 166b3028acd98e2b7fd09344f9005c5b20bba91262cZack Rusin */ 167287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell struct pipe_resource *(*user_buffer_create)(struct pipe_screen *screen, 168287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell void *ptr, 169287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell unsigned bytes, 170287c94ea4987033f9c99a2f91c5750c9083504caKeith Whitwell unsigned bind_flags); 171f547472bfa0a797adacc2a7688b4c1ba65381a80Younes Manton 17232da02f7c19f49802fe9589e73c3945502a197c9Ben Skeggs /** 173adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Do any special operations to ensure frontbuffer contents are 174adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * displayed, eg copy fake frontbuffer. 175e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu * \param winsys_drawable_handle an opaque handle that the calling context 176e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu * gets out-of-band 177adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 178adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin void (*flush_frontbuffer)( struct pipe_screen *screen, 179adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_surface *surf, 180e4848d21e8f384f4157076d5e7c7c9d38da6598eChia-I Wu void *winsys_drawable_handle ); 181adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 182adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 183adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 184adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** Set ptr = fence, with reference counting */ 185adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin void (*fence_reference)( struct pipe_screen *screen, 186adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle **ptr, 187adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle *fence ); 188adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 189adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** 190adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Checks whether the fence has been signalled. 191adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * \param flags driver-specific meaning 192adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * \return zero on success. 193adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 194adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin int (*fence_signalled)( struct pipe_screen *screen, 195adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle *fence, 1967ea265888f19bcbc1771f6c671ce08855b80bf0aJosé Fonseca unsigned flags ); 197adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 198adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin /** 199adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * Wait for the fence to finish. 200adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * \param flags driver-specific meaning 201adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin * \return zero on success. 202adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin */ 203adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin int (*fence_finish)( struct pipe_screen *screen, 204adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin struct pipe_fence_handle *fence, 2057ea265888f19bcbc1771f6c671ce08855b80bf0aJosé Fonseca unsigned flags ); 206adfbba476db1fc55006efb748656ebb1a481d143Zack Rusin 207aa59a937ccf41609081d3f9a4973df5478979785Brian}; 208aa59a937ccf41609081d3f9a4973df5478979785Brian 209aa59a937ccf41609081d3f9a4973df5478979785Brian 210aa59a937ccf41609081d3f9a4973df5478979785Brian#ifdef __cplusplus 211aa59a937ccf41609081d3f9a4973df5478979785Brian} 212aa59a937ccf41609081d3f9a4973df5478979785Brian#endif 213aa59a937ccf41609081d3f9a4973df5478979785Brian 214aa59a937ccf41609081d3f9a4973df5478979785Brian#endif /* P_SCREEN_H */ 215