graphics.h 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967
  1. /******************************************************************************
  2. Copyright (C) 2013 by Hugh Bailey <[email protected]>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. ******************************************************************************/
  14. #pragma once
  15. #include "../util/bmem.h"
  16. #include "input.h"
  17. #ifdef __APPLE__
  18. #include <objc/objc-runtime.h>
  19. #endif
  20. /*
  21. * This is an API-independent graphics subsystem wrapper.
  22. *
  23. * This allows the use of OpenGL and different Direct3D versions through
  24. * one shared interface.
  25. */
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29. #define GS_MAX_TEXTURES 8
  30. struct vec2;
  31. struct vec3;
  32. struct vec4;
  33. struct quat;
  34. struct axisang;
  35. struct plane;
  36. struct matrix3;
  37. struct matrix4;
  38. enum gs_draw_mode {
  39. GS_POINTS,
  40. GS_LINES,
  41. GS_LINESTRIP,
  42. GS_TRIS,
  43. GS_TRISTRIP,
  44. };
  45. enum gs_color_format {
  46. GS_UNKNOWN,
  47. GS_A8,
  48. GS_R8,
  49. GS_RGBA,
  50. GS_BGRX,
  51. GS_BGRA,
  52. GS_R10G10B10A2,
  53. GS_RGBA16,
  54. GS_R16,
  55. GS_RGBA16F,
  56. GS_RGBA32F,
  57. GS_RG16F,
  58. GS_RG32F,
  59. GS_R16F,
  60. GS_R32F,
  61. GS_DXT1,
  62. GS_DXT3,
  63. GS_DXT5,
  64. GS_R8G8,
  65. };
  66. enum gs_zstencil_format {
  67. GS_ZS_NONE,
  68. GS_Z16,
  69. GS_Z24_S8,
  70. GS_Z32F,
  71. GS_Z32F_S8X24,
  72. };
  73. enum gs_index_type {
  74. GS_UNSIGNED_SHORT,
  75. GS_UNSIGNED_LONG,
  76. };
  77. enum gs_cull_mode {
  78. GS_BACK,
  79. GS_FRONT,
  80. GS_NEITHER,
  81. };
  82. enum gs_blend_type {
  83. GS_BLEND_ZERO,
  84. GS_BLEND_ONE,
  85. GS_BLEND_SRCCOLOR,
  86. GS_BLEND_INVSRCCOLOR,
  87. GS_BLEND_SRCALPHA,
  88. GS_BLEND_INVSRCALPHA,
  89. GS_BLEND_DSTCOLOR,
  90. GS_BLEND_INVDSTCOLOR,
  91. GS_BLEND_DSTALPHA,
  92. GS_BLEND_INVDSTALPHA,
  93. GS_BLEND_SRCALPHASAT,
  94. };
  95. enum gs_depth_test {
  96. GS_NEVER,
  97. GS_LESS,
  98. GS_LEQUAL,
  99. GS_EQUAL,
  100. GS_GEQUAL,
  101. GS_GREATER,
  102. GS_NOTEQUAL,
  103. GS_ALWAYS,
  104. };
  105. enum gs_stencil_side {
  106. GS_STENCIL_FRONT = 1,
  107. GS_STENCIL_BACK,
  108. GS_STENCIL_BOTH,
  109. };
  110. enum gs_stencil_op_type {
  111. GS_KEEP,
  112. GS_ZERO,
  113. GS_REPLACE,
  114. GS_INCR,
  115. GS_DECR,
  116. GS_INVERT,
  117. };
  118. enum gs_cube_sides {
  119. GS_POSITIVE_X,
  120. GS_NEGATIVE_X,
  121. GS_POSITIVE_Y,
  122. GS_NEGATIVE_Y,
  123. GS_POSITIVE_Z,
  124. GS_NEGATIVE_Z,
  125. };
  126. enum gs_sample_filter {
  127. GS_FILTER_POINT,
  128. GS_FILTER_LINEAR,
  129. GS_FILTER_ANISOTROPIC,
  130. GS_FILTER_MIN_MAG_POINT_MIP_LINEAR,
  131. GS_FILTER_MIN_POINT_MAG_LINEAR_MIP_POINT,
  132. GS_FILTER_MIN_POINT_MAG_MIP_LINEAR,
  133. GS_FILTER_MIN_LINEAR_MAG_MIP_POINT,
  134. GS_FILTER_MIN_LINEAR_MAG_POINT_MIP_LINEAR,
  135. GS_FILTER_MIN_MAG_LINEAR_MIP_POINT,
  136. };
  137. enum gs_address_mode {
  138. GS_ADDRESS_CLAMP,
  139. GS_ADDRESS_WRAP,
  140. GS_ADDRESS_MIRROR,
  141. GS_ADDRESS_BORDER,
  142. GS_ADDRESS_MIRRORONCE,
  143. };
  144. enum gs_texture_type {
  145. GS_TEXTURE_2D,
  146. GS_TEXTURE_3D,
  147. GS_TEXTURE_CUBE,
  148. };
  149. struct gs_device_loss {
  150. void (*device_loss_release)(void *data);
  151. void (*device_loss_rebuild)(void *device, void *data);
  152. void *data;
  153. };
  154. struct gs_monitor_info {
  155. int rotation_degrees;
  156. long x;
  157. long y;
  158. long cx;
  159. long cy;
  160. };
  161. struct gs_tvertarray {
  162. size_t width;
  163. void *array;
  164. };
  165. struct gs_vb_data {
  166. size_t num;
  167. struct vec3 *points;
  168. struct vec3 *normals;
  169. struct vec3 *tangents;
  170. uint32_t *colors;
  171. size_t num_tex;
  172. struct gs_tvertarray *tvarray;
  173. };
  174. static inline struct gs_vb_data *gs_vbdata_create(void)
  175. {
  176. return (struct gs_vb_data *)bzalloc(sizeof(struct gs_vb_data));
  177. }
  178. static inline void gs_vbdata_destroy(struct gs_vb_data *data)
  179. {
  180. uint32_t i;
  181. if (!data)
  182. return;
  183. bfree(data->points);
  184. bfree(data->normals);
  185. bfree(data->tangents);
  186. bfree(data->colors);
  187. for (i = 0; i < data->num_tex; i++)
  188. bfree(data->tvarray[i].array);
  189. bfree(data->tvarray);
  190. bfree(data);
  191. }
  192. struct gs_sampler_info {
  193. enum gs_sample_filter filter;
  194. enum gs_address_mode address_u;
  195. enum gs_address_mode address_v;
  196. enum gs_address_mode address_w;
  197. int max_anisotropy;
  198. uint32_t border_color;
  199. };
  200. struct gs_display_mode {
  201. uint32_t width;
  202. uint32_t height;
  203. uint32_t bits;
  204. uint32_t freq;
  205. };
  206. struct gs_rect {
  207. int x;
  208. int y;
  209. int cx;
  210. int cy;
  211. };
  212. /* wrapped opaque data types */
  213. struct gs_texture;
  214. struct gs_stage_surface;
  215. struct gs_zstencil_buffer;
  216. struct gs_vertex_buffer;
  217. struct gs_index_buffer;
  218. struct gs_sampler_state;
  219. struct gs_shader;
  220. struct gs_swap_chain;
  221. struct gs_timer;
  222. struct gs_texrender;
  223. struct gs_shader_param;
  224. struct gs_effect;
  225. struct gs_effect_technique;
  226. struct gs_effect_pass;
  227. struct gs_effect_param;
  228. struct gs_device;
  229. struct graphics_subsystem;
  230. typedef struct gs_texture gs_texture_t;
  231. typedef struct gs_stage_surface gs_stagesurf_t;
  232. typedef struct gs_zstencil_buffer gs_zstencil_t;
  233. typedef struct gs_vertex_buffer gs_vertbuffer_t;
  234. typedef struct gs_index_buffer gs_indexbuffer_t;
  235. typedef struct gs_sampler_state gs_samplerstate_t;
  236. typedef struct gs_swap_chain gs_swapchain_t;
  237. typedef struct gs_timer gs_timer_t;
  238. typedef struct gs_timer_range gs_timer_range_t;
  239. typedef struct gs_texture_render gs_texrender_t;
  240. typedef struct gs_shader gs_shader_t;
  241. typedef struct gs_shader_param gs_sparam_t;
  242. typedef struct gs_effect gs_effect_t;
  243. typedef struct gs_effect_technique gs_technique_t;
  244. typedef struct gs_effect_pass gs_epass_t;
  245. typedef struct gs_effect_param gs_eparam_t;
  246. typedef struct gs_device gs_device_t;
  247. typedef struct graphics_subsystem graphics_t;
  248. /* ---------------------------------------------------
  249. * shader functions
  250. * --------------------------------------------------- */
  251. enum gs_shader_param_type {
  252. GS_SHADER_PARAM_UNKNOWN,
  253. GS_SHADER_PARAM_BOOL,
  254. GS_SHADER_PARAM_FLOAT,
  255. GS_SHADER_PARAM_INT,
  256. GS_SHADER_PARAM_STRING,
  257. GS_SHADER_PARAM_VEC2,
  258. GS_SHADER_PARAM_VEC3,
  259. GS_SHADER_PARAM_VEC4,
  260. GS_SHADER_PARAM_INT2,
  261. GS_SHADER_PARAM_INT3,
  262. GS_SHADER_PARAM_INT4,
  263. GS_SHADER_PARAM_MATRIX4X4,
  264. GS_SHADER_PARAM_TEXTURE,
  265. };
  266. #ifndef SWIG
  267. struct gs_shader_param_info {
  268. enum gs_shader_param_type type;
  269. const char *name;
  270. };
  271. enum gs_shader_type {
  272. GS_SHADER_VERTEX,
  273. GS_SHADER_PIXEL,
  274. };
  275. EXPORT void gs_shader_destroy(gs_shader_t *shader);
  276. EXPORT int gs_shader_get_num_params(const gs_shader_t *shader);
  277. EXPORT gs_sparam_t *gs_shader_get_param_by_idx(gs_shader_t *shader,
  278. uint32_t param);
  279. EXPORT gs_sparam_t *gs_shader_get_param_by_name(gs_shader_t *shader,
  280. const char *name);
  281. EXPORT gs_sparam_t *gs_shader_get_viewproj_matrix(const gs_shader_t *shader);
  282. EXPORT gs_sparam_t *gs_shader_get_world_matrix(const gs_shader_t *shader);
  283. EXPORT void gs_shader_get_param_info(const gs_sparam_t *param,
  284. struct gs_shader_param_info *info);
  285. EXPORT void gs_shader_set_bool(gs_sparam_t *param, bool val);
  286. EXPORT void gs_shader_set_float(gs_sparam_t *param, float val);
  287. EXPORT void gs_shader_set_int(gs_sparam_t *param, int val);
  288. EXPORT void gs_shader_set_matrix3(gs_sparam_t *param,
  289. const struct matrix3 *val);
  290. EXPORT void gs_shader_set_matrix4(gs_sparam_t *param,
  291. const struct matrix4 *val);
  292. EXPORT void gs_shader_set_vec2(gs_sparam_t *param, const struct vec2 *val);
  293. EXPORT void gs_shader_set_vec3(gs_sparam_t *param, const struct vec3 *val);
  294. EXPORT void gs_shader_set_vec4(gs_sparam_t *param, const struct vec4 *val);
  295. EXPORT void gs_shader_set_texture(gs_sparam_t *param, gs_texture_t *val);
  296. EXPORT void gs_shader_set_val(gs_sparam_t *param, const void *val, size_t size);
  297. EXPORT void gs_shader_set_default(gs_sparam_t *param);
  298. EXPORT void gs_shader_set_next_sampler(gs_sparam_t *param,
  299. gs_samplerstate_t *sampler);
  300. #endif
  301. /* ---------------------------------------------------
  302. * effect functions
  303. * --------------------------------------------------- */
  304. /*enum gs_effect_property_type {
  305. GS_EFFECT_NONE,
  306. GS_EFFECT_BOOL,
  307. GS_EFFECT_FLOAT,
  308. GS_EFFECT_COLOR,
  309. GS_EFFECT_TEXTURE
  310. };*/
  311. #ifndef SWIG
  312. struct gs_effect_param_info {
  313. const char *name;
  314. enum gs_shader_param_type type;
  315. /* const char *full_name;
  316. enum gs_effect_property_type prop_type;
  317. float min, max, inc, mul; */
  318. };
  319. #endif
  320. EXPORT void gs_effect_destroy(gs_effect_t *effect);
  321. EXPORT gs_technique_t *gs_effect_get_technique(const gs_effect_t *effect,
  322. const char *name);
  323. EXPORT gs_technique_t *
  324. gs_effect_get_current_technique(const gs_effect_t *effect);
  325. EXPORT size_t gs_technique_begin(gs_technique_t *technique);
  326. EXPORT void gs_technique_end(gs_technique_t *technique);
  327. EXPORT bool gs_technique_begin_pass(gs_technique_t *technique, size_t pass);
  328. EXPORT bool gs_technique_begin_pass_by_name(gs_technique_t *technique,
  329. const char *name);
  330. EXPORT void gs_technique_end_pass(gs_technique_t *technique);
  331. EXPORT gs_epass_t *gs_technique_get_pass_by_idx(const gs_technique_t *technique,
  332. size_t pass);
  333. EXPORT gs_epass_t *
  334. gs_technique_get_pass_by_name(const gs_technique_t *technique,
  335. const char *name);
  336. EXPORT size_t gs_effect_get_num_params(const gs_effect_t *effect);
  337. EXPORT gs_eparam_t *gs_effect_get_param_by_idx(const gs_effect_t *effect,
  338. size_t param);
  339. EXPORT gs_eparam_t *gs_effect_get_param_by_name(const gs_effect_t *effect,
  340. const char *name);
  341. EXPORT size_t gs_param_get_num_annotations(const gs_eparam_t *param);
  342. EXPORT gs_eparam_t *gs_param_get_annotation_by_idx(const gs_eparam_t *param,
  343. size_t annotation);
  344. EXPORT gs_eparam_t *gs_param_get_annotation_by_name(const gs_eparam_t *param,
  345. const char *name);
  346. /** Helper function to simplify effect usage. Use with a while loop that
  347. * contains drawing functions. Automatically handles techniques, passes, and
  348. * unloading. */
  349. EXPORT bool gs_effect_loop(gs_effect_t *effect, const char *name);
  350. /** used internally */
  351. EXPORT void gs_effect_update_params(gs_effect_t *effect);
  352. EXPORT gs_eparam_t *gs_effect_get_viewproj_matrix(const gs_effect_t *effect);
  353. EXPORT gs_eparam_t *gs_effect_get_world_matrix(const gs_effect_t *effect);
  354. #ifndef SWIG
  355. EXPORT void gs_effect_get_param_info(const gs_eparam_t *param,
  356. struct gs_effect_param_info *info);
  357. #endif
  358. EXPORT void gs_effect_set_bool(gs_eparam_t *param, bool val);
  359. EXPORT void gs_effect_set_float(gs_eparam_t *param, float val);
  360. EXPORT void gs_effect_set_int(gs_eparam_t *param, int val);
  361. EXPORT void gs_effect_set_matrix4(gs_eparam_t *param,
  362. const struct matrix4 *val);
  363. EXPORT void gs_effect_set_vec2(gs_eparam_t *param, const struct vec2 *val);
  364. EXPORT void gs_effect_set_vec3(gs_eparam_t *param, const struct vec3 *val);
  365. EXPORT void gs_effect_set_vec4(gs_eparam_t *param, const struct vec4 *val);
  366. EXPORT void gs_effect_set_texture(gs_eparam_t *param, gs_texture_t *val);
  367. EXPORT void gs_effect_set_val(gs_eparam_t *param, const void *val, size_t size);
  368. EXPORT void gs_effect_set_default(gs_eparam_t *param);
  369. EXPORT size_t gs_effect_get_val_size(gs_eparam_t *param);
  370. EXPORT void *gs_effect_get_val(gs_eparam_t *param);
  371. EXPORT size_t gs_effect_get_default_val_size(gs_eparam_t *param);
  372. EXPORT void *gs_effect_get_default_val(gs_eparam_t *param);
  373. EXPORT void gs_effect_set_next_sampler(gs_eparam_t *param,
  374. gs_samplerstate_t *sampler);
  375. EXPORT void gs_effect_set_color(gs_eparam_t *param, uint32_t argb);
  376. /* ---------------------------------------------------
  377. * texture render helper functions
  378. * --------------------------------------------------- */
  379. EXPORT gs_texrender_t *gs_texrender_create(enum gs_color_format format,
  380. enum gs_zstencil_format zsformat);
  381. EXPORT void gs_texrender_destroy(gs_texrender_t *texrender);
  382. EXPORT bool gs_texrender_begin(gs_texrender_t *texrender, uint32_t cx,
  383. uint32_t cy);
  384. EXPORT void gs_texrender_end(gs_texrender_t *texrender);
  385. EXPORT void gs_texrender_reset(gs_texrender_t *texrender);
  386. EXPORT gs_texture_t *gs_texrender_get_texture(const gs_texrender_t *texrender);
  387. /* ---------------------------------------------------
  388. * graphics subsystem
  389. * --------------------------------------------------- */
  390. #define GS_BUILD_MIPMAPS (1 << 0)
  391. #define GS_DYNAMIC (1 << 1)
  392. #define GS_RENDER_TARGET (1 << 2)
  393. #define GS_GL_DUMMYTEX (1 << 3) /**<< texture with no allocated texture data */
  394. #define GS_DUP_BUFFER \
  395. (1 << 4) /**<< do not pass buffer ownership when
  396. * creating a vertex/index buffer */
  397. #define GS_SHARED_TEX (1 << 5)
  398. #define GS_SHARED_KM_TEX (1 << 6)
  399. /* ---------------- */
  400. /* global functions */
  401. #define GS_SUCCESS 0
  402. #define GS_ERROR_FAIL -1
  403. #define GS_ERROR_MODULE_NOT_FOUND -2
  404. #define GS_ERROR_NOT_SUPPORTED -3
  405. struct gs_window {
  406. #if defined(_WIN32)
  407. void *hwnd;
  408. #elif defined(__APPLE__)
  409. __unsafe_unretained id view;
  410. #elif defined(__linux__) || defined(__FreeBSD__)
  411. /* I'm not sure how portable defining id to uint32_t is. */
  412. uint32_t id;
  413. void *display;
  414. #endif
  415. };
  416. struct gs_init_data {
  417. struct gs_window window;
  418. uint32_t cx, cy;
  419. uint32_t num_backbuffers;
  420. enum gs_color_format format;
  421. enum gs_zstencil_format zsformat;
  422. uint32_t adapter;
  423. };
  424. #define GS_DEVICE_OPENGL 1
  425. #define GS_DEVICE_DIRECT3D_11 2
  426. EXPORT const char *gs_get_device_name(void);
  427. EXPORT int gs_get_device_type(void);
  428. EXPORT void gs_enum_adapters(bool (*callback)(void *param, const char *name,
  429. uint32_t id),
  430. void *param);
  431. EXPORT int gs_create(graphics_t **graphics, const char *module,
  432. uint32_t adapter);
  433. EXPORT void gs_destroy(graphics_t *graphics);
  434. EXPORT void gs_enter_context(graphics_t *graphics);
  435. EXPORT void gs_leave_context(void);
  436. EXPORT graphics_t *gs_get_context(void);
  437. EXPORT void *gs_get_device_obj(void);
  438. EXPORT void gs_matrix_push(void);
  439. EXPORT void gs_matrix_pop(void);
  440. EXPORT void gs_matrix_identity(void);
  441. EXPORT void gs_matrix_transpose(void);
  442. EXPORT void gs_matrix_set(const struct matrix4 *matrix);
  443. EXPORT void gs_matrix_get(struct matrix4 *dst);
  444. EXPORT void gs_matrix_mul(const struct matrix4 *matrix);
  445. EXPORT void gs_matrix_rotquat(const struct quat *rot);
  446. EXPORT void gs_matrix_rotaa(const struct axisang *rot);
  447. EXPORT void gs_matrix_translate(const struct vec3 *pos);
  448. EXPORT void gs_matrix_scale(const struct vec3 *scale);
  449. EXPORT void gs_matrix_rotaa4f(float x, float y, float z, float angle);
  450. EXPORT void gs_matrix_translate3f(float x, float y, float z);
  451. EXPORT void gs_matrix_scale3f(float x, float y, float z);
  452. EXPORT void gs_render_start(bool b_new);
  453. EXPORT void gs_render_stop(enum gs_draw_mode mode);
  454. EXPORT gs_vertbuffer_t *gs_render_save(void);
  455. EXPORT void gs_vertex2f(float x, float y);
  456. EXPORT void gs_vertex3f(float x, float y, float z);
  457. EXPORT void gs_normal3f(float x, float y, float z);
  458. EXPORT void gs_color(uint32_t color);
  459. EXPORT void gs_texcoord(float x, float y, int unit);
  460. EXPORT void gs_vertex2v(const struct vec2 *v);
  461. EXPORT void gs_vertex3v(const struct vec3 *v);
  462. EXPORT void gs_normal3v(const struct vec3 *v);
  463. EXPORT void gs_color4v(const struct vec4 *v);
  464. EXPORT void gs_texcoord2v(const struct vec2 *v, int unit);
  465. EXPORT input_t *gs_get_input(void);
  466. EXPORT gs_effect_t *gs_get_effect(void);
  467. EXPORT gs_effect_t *gs_effect_create_from_file(const char *file,
  468. char **error_string);
  469. EXPORT gs_effect_t *gs_effect_create(const char *effect_string,
  470. const char *filename, char **error_string);
  471. EXPORT gs_shader_t *gs_vertexshader_create_from_file(const char *file,
  472. char **error_string);
  473. EXPORT gs_shader_t *gs_pixelshader_create_from_file(const char *file,
  474. char **error_string);
  475. EXPORT gs_texture_t *gs_texture_create_from_file(const char *file);
  476. EXPORT uint8_t *gs_create_texture_file_data(const char *file,
  477. enum gs_color_format *format,
  478. uint32_t *cx, uint32_t *cy);
  479. #define GS_FLIP_U (1 << 0)
  480. #define GS_FLIP_V (1 << 1)
  481. /**
  482. * Draws a 2D sprite
  483. *
  484. * If width or height is 0, the width or height of the texture will be used.
  485. * The flip value specifies whether the texture should be flipped on the U or V
  486. * axis with GS_FLIP_U and GS_FLIP_V.
  487. */
  488. EXPORT void gs_draw_sprite(gs_texture_t *tex, uint32_t flip, uint32_t width,
  489. uint32_t height);
  490. EXPORT void gs_draw_sprite_subregion(gs_texture_t *tex, uint32_t flip,
  491. uint32_t x, uint32_t y, uint32_t cx,
  492. uint32_t cy);
  493. EXPORT void gs_draw_cube_backdrop(gs_texture_t *cubetex, const struct quat *rot,
  494. float left, float right, float top,
  495. float bottom, float znear);
  496. /** sets the viewport to current swap chain size */
  497. EXPORT void gs_reset_viewport(void);
  498. /** sets default screen-sized orthographic mode */
  499. EXPORT void gs_set_2d_mode(void);
  500. /** sets default screen-sized perspective mode */
  501. EXPORT void gs_set_3d_mode(double fovy, double znear, double zvar);
  502. EXPORT void gs_viewport_push(void);
  503. EXPORT void gs_viewport_pop(void);
  504. EXPORT void gs_texture_set_image(gs_texture_t *tex, const uint8_t *data,
  505. uint32_t linesize, bool invert);
  506. EXPORT void gs_cubetexture_set_image(gs_texture_t *cubetex, uint32_t side,
  507. const void *data, uint32_t linesize,
  508. bool invert);
  509. EXPORT void gs_perspective(float fovy, float aspect, float znear, float zfar);
  510. EXPORT void gs_blend_state_push(void);
  511. EXPORT void gs_blend_state_pop(void);
  512. EXPORT void gs_reset_blend_state(void);
  513. /* -------------------------- */
  514. /* library-specific functions */
  515. EXPORT gs_swapchain_t *gs_swapchain_create(const struct gs_init_data *data);
  516. EXPORT void gs_resize(uint32_t x, uint32_t y);
  517. EXPORT void gs_get_size(uint32_t *x, uint32_t *y);
  518. EXPORT uint32_t gs_get_width(void);
  519. EXPORT uint32_t gs_get_height(void);
  520. EXPORT gs_texture_t *gs_texture_create(uint32_t width, uint32_t height,
  521. enum gs_color_format color_format,
  522. uint32_t levels, const uint8_t **data,
  523. uint32_t flags);
  524. EXPORT gs_texture_t *
  525. gs_cubetexture_create(uint32_t size, enum gs_color_format color_format,
  526. uint32_t levels, const uint8_t **data, uint32_t flags);
  527. EXPORT gs_texture_t *gs_voltexture_create(uint32_t width, uint32_t height,
  528. uint32_t depth,
  529. enum gs_color_format color_format,
  530. uint32_t levels, const uint8_t **data,
  531. uint32_t flags);
  532. EXPORT gs_zstencil_t *gs_zstencil_create(uint32_t width, uint32_t height,
  533. enum gs_zstencil_format format);
  534. EXPORT gs_stagesurf_t *
  535. gs_stagesurface_create(uint32_t width, uint32_t height,
  536. enum gs_color_format color_format);
  537. EXPORT gs_samplerstate_t *
  538. gs_samplerstate_create(const struct gs_sampler_info *info);
  539. EXPORT gs_shader_t *gs_vertexshader_create(const char *shader, const char *file,
  540. char **error_string);
  541. EXPORT gs_shader_t *gs_pixelshader_create(const char *shader, const char *file,
  542. char **error_string);
  543. EXPORT gs_vertbuffer_t *gs_vertexbuffer_create(struct gs_vb_data *data,
  544. uint32_t flags);
  545. EXPORT gs_indexbuffer_t *gs_indexbuffer_create(enum gs_index_type type,
  546. void *indices, size_t num,
  547. uint32_t flags);
  548. EXPORT gs_timer_t *gs_timer_create();
  549. EXPORT gs_timer_range_t *gs_timer_range_create();
  550. EXPORT enum gs_texture_type gs_get_texture_type(const gs_texture_t *texture);
  551. EXPORT void gs_load_vertexbuffer(gs_vertbuffer_t *vertbuffer);
  552. EXPORT void gs_load_indexbuffer(gs_indexbuffer_t *indexbuffer);
  553. EXPORT void gs_load_texture(gs_texture_t *tex, int unit);
  554. EXPORT void gs_load_samplerstate(gs_samplerstate_t *samplerstate, int unit);
  555. EXPORT void gs_load_vertexshader(gs_shader_t *vertshader);
  556. EXPORT void gs_load_pixelshader(gs_shader_t *pixelshader);
  557. EXPORT void gs_load_default_samplerstate(bool b_3d, int unit);
  558. EXPORT gs_shader_t *gs_get_vertex_shader(void);
  559. EXPORT gs_shader_t *gs_get_pixel_shader(void);
  560. EXPORT gs_texture_t *gs_get_render_target(void);
  561. EXPORT gs_zstencil_t *gs_get_zstencil_target(void);
  562. EXPORT void gs_set_render_target(gs_texture_t *tex, gs_zstencil_t *zstencil);
  563. EXPORT void gs_set_cube_render_target(gs_texture_t *cubetex, int side,
  564. gs_zstencil_t *zstencil);
  565. EXPORT void gs_copy_texture(gs_texture_t *dst, gs_texture_t *src);
  566. EXPORT void gs_copy_texture_region(gs_texture_t *dst, uint32_t dst_x,
  567. uint32_t dst_y, gs_texture_t *src,
  568. uint32_t src_x, uint32_t src_y,
  569. uint32_t src_w, uint32_t src_h);
  570. EXPORT void gs_stage_texture(gs_stagesurf_t *dst, gs_texture_t *src);
  571. EXPORT void gs_begin_frame(void);
  572. EXPORT void gs_begin_scene(void);
  573. EXPORT void gs_draw(enum gs_draw_mode draw_mode, uint32_t start_vert,
  574. uint32_t num_verts);
  575. EXPORT void gs_end_scene(void);
  576. #define GS_CLEAR_COLOR (1 << 0)
  577. #define GS_CLEAR_DEPTH (1 << 1)
  578. #define GS_CLEAR_STENCIL (1 << 2)
  579. EXPORT void gs_load_swapchain(gs_swapchain_t *swapchain);
  580. EXPORT void gs_clear(uint32_t clear_flags, const struct vec4 *color,
  581. float depth, uint8_t stencil);
  582. EXPORT void gs_present(void);
  583. EXPORT void gs_flush(void);
  584. EXPORT void gs_set_cull_mode(enum gs_cull_mode mode);
  585. EXPORT enum gs_cull_mode gs_get_cull_mode(void);
  586. EXPORT void gs_enable_blending(bool enable);
  587. EXPORT void gs_enable_depth_test(bool enable);
  588. EXPORT void gs_enable_stencil_test(bool enable);
  589. EXPORT void gs_enable_stencil_write(bool enable);
  590. EXPORT void gs_enable_color(bool red, bool green, bool blue, bool alpha);
  591. EXPORT void gs_blend_function(enum gs_blend_type src, enum gs_blend_type dest);
  592. EXPORT void gs_blend_function_separate(enum gs_blend_type src_c,
  593. enum gs_blend_type dest_c,
  594. enum gs_blend_type src_a,
  595. enum gs_blend_type dest_a);
  596. EXPORT void gs_depth_function(enum gs_depth_test test);
  597. EXPORT void gs_stencil_function(enum gs_stencil_side side,
  598. enum gs_depth_test test);
  599. EXPORT void gs_stencil_op(enum gs_stencil_side side,
  600. enum gs_stencil_op_type fail,
  601. enum gs_stencil_op_type zfail,
  602. enum gs_stencil_op_type zpass);
  603. EXPORT void gs_set_viewport(int x, int y, int width, int height);
  604. EXPORT void gs_get_viewport(struct gs_rect *rect);
  605. EXPORT void gs_set_scissor_rect(const struct gs_rect *rect);
  606. EXPORT void gs_ortho(float left, float right, float top, float bottom,
  607. float znear, float zfar);
  608. EXPORT void gs_frustum(float left, float right, float top, float bottom,
  609. float znear, float zfar);
  610. EXPORT void gs_projection_push(void);
  611. EXPORT void gs_projection_pop(void);
  612. EXPORT void gs_swapchain_destroy(gs_swapchain_t *swapchain);
  613. EXPORT void gs_texture_destroy(gs_texture_t *tex);
  614. EXPORT uint32_t gs_texture_get_width(const gs_texture_t *tex);
  615. EXPORT uint32_t gs_texture_get_height(const gs_texture_t *tex);
  616. EXPORT enum gs_color_format
  617. gs_texture_get_color_format(const gs_texture_t *tex);
  618. EXPORT bool gs_texture_map(gs_texture_t *tex, uint8_t **ptr,
  619. uint32_t *linesize);
  620. EXPORT void gs_texture_unmap(gs_texture_t *tex);
  621. /** special-case function (GL only) - specifies whether the texture is a
  622. * GL_TEXTURE_RECTANGLE type, which doesn't use normalized texture
  623. * coordinates, doesn't support mipmapping, and requires address clamping */
  624. EXPORT bool gs_texture_is_rect(const gs_texture_t *tex);
  625. /**
  626. * Gets a pointer to the context-specific object associated with the texture.
  627. * For example, for GL, this is a GLuint*. For D3D11, ID3D11Texture2D*.
  628. */
  629. EXPORT void *gs_texture_get_obj(gs_texture_t *tex);
  630. EXPORT void gs_cubetexture_destroy(gs_texture_t *cubetex);
  631. EXPORT uint32_t gs_cubetexture_get_size(const gs_texture_t *cubetex);
  632. EXPORT enum gs_color_format
  633. gs_cubetexture_get_color_format(const gs_texture_t *cubetex);
  634. EXPORT void gs_voltexture_destroy(gs_texture_t *voltex);
  635. EXPORT uint32_t gs_voltexture_get_width(const gs_texture_t *voltex);
  636. EXPORT uint32_t gs_voltexture_get_height(const gs_texture_t *voltex);
  637. EXPORT uint32_t gs_voltexture_get_depth(const gs_texture_t *voltex);
  638. EXPORT enum gs_color_format
  639. gs_voltexture_get_color_format(const gs_texture_t *voltex);
  640. EXPORT void gs_stagesurface_destroy(gs_stagesurf_t *stagesurf);
  641. EXPORT uint32_t gs_stagesurface_get_width(const gs_stagesurf_t *stagesurf);
  642. EXPORT uint32_t gs_stagesurface_get_height(const gs_stagesurf_t *stagesurf);
  643. EXPORT enum gs_color_format
  644. gs_stagesurface_get_color_format(const gs_stagesurf_t *stagesurf);
  645. EXPORT bool gs_stagesurface_map(gs_stagesurf_t *stagesurf, uint8_t **data,
  646. uint32_t *linesize);
  647. EXPORT void gs_stagesurface_unmap(gs_stagesurf_t *stagesurf);
  648. EXPORT void gs_zstencil_destroy(gs_zstencil_t *zstencil);
  649. EXPORT void gs_samplerstate_destroy(gs_samplerstate_t *samplerstate);
  650. EXPORT void gs_vertexbuffer_destroy(gs_vertbuffer_t *vertbuffer);
  651. EXPORT void gs_vertexbuffer_flush(gs_vertbuffer_t *vertbuffer);
  652. EXPORT void gs_vertexbuffer_flush_direct(gs_vertbuffer_t *vertbuffer,
  653. const struct gs_vb_data *data);
  654. EXPORT struct gs_vb_data *
  655. gs_vertexbuffer_get_data(const gs_vertbuffer_t *vertbuffer);
  656. EXPORT void gs_indexbuffer_destroy(gs_indexbuffer_t *indexbuffer);
  657. EXPORT void gs_indexbuffer_flush(gs_indexbuffer_t *indexbuffer);
  658. EXPORT void gs_indexbuffer_flush_direct(gs_indexbuffer_t *indexbuffer,
  659. const void *data);
  660. EXPORT void *gs_indexbuffer_get_data(const gs_indexbuffer_t *indexbuffer);
  661. EXPORT size_t
  662. gs_indexbuffer_get_num_indices(const gs_indexbuffer_t *indexbuffer);
  663. EXPORT enum gs_index_type
  664. gs_indexbuffer_get_type(const gs_indexbuffer_t *indexbuffer);
  665. EXPORT void gs_timer_destroy(gs_timer_t *timer);
  666. EXPORT void gs_timer_begin(gs_timer_t *timer);
  667. EXPORT void gs_timer_end(gs_timer_t *timer);
  668. EXPORT bool gs_timer_get_data(gs_timer_t *timer, uint64_t *ticks);
  669. EXPORT void gs_timer_range_destroy(gs_timer_range_t *timer);
  670. EXPORT void gs_timer_range_begin(gs_timer_range_t *range);
  671. EXPORT void gs_timer_range_end(gs_timer_range_t *range);
  672. EXPORT bool gs_timer_range_get_data(gs_timer_range_t *range, bool *disjoint,
  673. uint64_t *frequency);
  674. EXPORT bool gs_nv12_available(void);
  675. #define GS_USE_DEBUG_MARKERS 0
  676. #if GS_USE_DEBUG_MARKERS
  677. static const float GS_DEBUG_COLOR_DEFAULT[] = {0.5f, 0.5f, 0.5f, 1.0f};
  678. static const float GS_DEBUG_COLOR_RENDER_VIDEO[] = {0.0f, 0.5f, 0.0f, 1.0f};
  679. static const float GS_DEBUG_COLOR_MAIN_TEXTURE[] = {0.0f, 0.25f, 0.0f, 1.0f};
  680. static const float GS_DEBUG_COLOR_DISPLAY[] = {0.0f, 0.5f, 0.5f, 1.0f};
  681. static const float GS_DEBUG_COLOR_SOURCE[] = {0.0f, 0.5f, 5.0f, 1.0f};
  682. static const float GS_DEBUG_COLOR_ITEM[] = {0.5f, 0.0f, 0.0f, 1.0f};
  683. static const float GS_DEBUG_COLOR_ITEM_TEXTURE[] = {0.25f, 0.0f, 0.0f, 1.0f};
  684. static const float GS_DEBUG_COLOR_CONVERT_FORMAT[] = {0.5f, 0.5f, 0.0f, 1.0f};
  685. #define GS_DEBUG_MARKER_BEGIN(color, markername) \
  686. gs_debug_marker_begin(color, markername)
  687. #define GS_DEBUG_MARKER_BEGIN_FORMAT(color, format, ...) \
  688. gs_debug_marker_begin_format(color, format, __VA_ARGS__)
  689. #define GS_DEBUG_MARKER_END() gs_debug_marker_end()
  690. #else
  691. #define GS_DEBUG_MARKER_BEGIN(color, markername) ((void)0)
  692. #define GS_DEBUG_MARKER_BEGIN_FORMAT(color, format, ...) ((void)0)
  693. #define GS_DEBUG_MARKER_END() ((void)0)
  694. #endif
  695. EXPORT void gs_debug_marker_begin(const float color[4], const char *markername);
  696. EXPORT void gs_debug_marker_begin_format(const float color[4],
  697. const char *format, ...);
  698. EXPORT void gs_debug_marker_end(void);
  699. #ifdef __APPLE__
  700. /** platform specific function for creating (GL_TEXTURE_RECTANGLE) textures
  701. * from shared surface resources */
  702. EXPORT gs_texture_t *gs_texture_create_from_iosurface(void *iosurf);
  703. EXPORT bool gs_texture_rebind_iosurface(gs_texture_t *texture, void *iosurf);
  704. #elif _WIN32
  705. EXPORT bool gs_gdi_texture_available(void);
  706. EXPORT bool gs_shared_texture_available(void);
  707. struct gs_duplicator;
  708. typedef struct gs_duplicator gs_duplicator_t;
  709. /**
  710. * Gets information about the monitor at the specific index, returns false
  711. * when there is no monitor at the specified index
  712. */
  713. EXPORT bool
  714. gs_get_duplicator_monitor_info(int monitor_idx,
  715. struct gs_monitor_info *monitor_info);
  716. /** creates a windows 8+ output duplicator (monitor capture) */
  717. EXPORT gs_duplicator_t *gs_duplicator_create(int monitor_idx);
  718. EXPORT void gs_duplicator_destroy(gs_duplicator_t *duplicator);
  719. EXPORT bool gs_duplicator_update_frame(gs_duplicator_t *duplicator);
  720. EXPORT gs_texture_t *gs_duplicator_get_texture(gs_duplicator_t *duplicator);
  721. /** creates a windows GDI-lockable texture */
  722. EXPORT gs_texture_t *gs_texture_create_gdi(uint32_t width, uint32_t height);
  723. EXPORT void *gs_texture_get_dc(gs_texture_t *gdi_tex);
  724. EXPORT void gs_texture_release_dc(gs_texture_t *gdi_tex);
  725. /** creates a windows shared texture from a texture handle */
  726. EXPORT gs_texture_t *gs_texture_open_shared(uint32_t handle);
  727. #define GS_INVALID_HANDLE (uint32_t) - 1
  728. EXPORT uint32_t gs_texture_get_shared_handle(gs_texture_t *tex);
  729. #define GS_WAIT_INFINITE (uint32_t) - 1
  730. /**
  731. * acquires a lock on a keyed mutex texture.
  732. * returns -1 on generic failure, ETIMEDOUT if timed out
  733. */
  734. EXPORT int gs_texture_acquire_sync(gs_texture_t *tex, uint64_t key,
  735. uint32_t ms);
  736. /**
  737. * releases a lock on a keyed mutex texture to another device.
  738. * return 0 on success, -1 on error
  739. */
  740. EXPORT int gs_texture_release_sync(gs_texture_t *tex, uint64_t key);
  741. EXPORT bool gs_texture_create_nv12(gs_texture_t **tex_y, gs_texture_t **tex_uv,
  742. uint32_t width, uint32_t height,
  743. uint32_t flags);
  744. EXPORT gs_stagesurf_t *gs_stagesurface_create_nv12(uint32_t width,
  745. uint32_t height);
  746. EXPORT void gs_register_loss_callbacks(const struct gs_device_loss *callbacks);
  747. EXPORT void gs_unregister_loss_callbacks(void *data);
  748. #endif
  749. /* inline functions used by modules */
  750. static inline uint32_t gs_get_format_bpp(enum gs_color_format format)
  751. {
  752. switch (format) {
  753. case GS_A8:
  754. return 8;
  755. case GS_R8:
  756. return 8;
  757. case GS_RGBA:
  758. return 32;
  759. case GS_BGRX:
  760. return 32;
  761. case GS_BGRA:
  762. return 32;
  763. case GS_R10G10B10A2:
  764. return 32;
  765. case GS_RGBA16:
  766. return 64;
  767. case GS_R16:
  768. return 16;
  769. case GS_RGBA16F:
  770. return 64;
  771. case GS_RGBA32F:
  772. return 128;
  773. case GS_RG16F:
  774. return 32;
  775. case GS_RG32F:
  776. return 64;
  777. case GS_R16F:
  778. return 16;
  779. case GS_R32F:
  780. return 32;
  781. case GS_DXT1:
  782. return 4;
  783. case GS_DXT3:
  784. return 8;
  785. case GS_DXT5:
  786. return 8;
  787. case GS_R8G8:
  788. return 16;
  789. case GS_UNKNOWN:
  790. return 0;
  791. }
  792. return 0;
  793. }
  794. static inline bool gs_is_compressed_format(enum gs_color_format format)
  795. {
  796. return (format == GS_DXT1 || format == GS_DXT3 || format == GS_DXT5);
  797. }
  798. static inline uint32_t gs_get_total_levels(uint32_t width, uint32_t height,
  799. uint32_t depth)
  800. {
  801. uint32_t size = width > height ? width : height;
  802. size = size > depth ? size : depth;
  803. uint32_t num_levels = 1;
  804. while (size > 1) {
  805. size /= 2;
  806. num_levels++;
  807. }
  808. return num_levels;
  809. }
  810. #ifdef __cplusplus
  811. }
  812. #endif