Open Broadcaster Software
Free, open source software for live streaming and recording
device-exports.h
Go to the documentation of this file.
1 /******************************************************************************
2  Copyright (C) 2013-2014 by Hugh Bailey <obs.jim@gmail.com>
3 
4  This program is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 2 of the License, or
7  (at your option) any later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with this program. If not, see <http://www.gnu.org/licenses/>.
16 ******************************************************************************/
17 
18 #pragma once
19 
20 #include <util/c99defs.h>
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 EXPORT const char *device_get_name(void);
27 EXPORT int device_get_type(void);
28 EXPORT bool device_enum_adapters(bool (*callback)(void *param, const char *name,
29  uint32_t id),
30  void *param);
31 EXPORT const char *device_preprocessor_name(void);
32 EXPORT int device_create(gs_device_t **device, uint32_t adapter);
33 EXPORT void device_destroy(gs_device_t *device);
38  const struct gs_init_data *data);
39 EXPORT void device_resize(gs_device_t *device, uint32_t x, uint32_t y);
40 EXPORT void device_get_size(const gs_device_t *device, uint32_t *x,
41  uint32_t *y);
42 EXPORT uint32_t device_get_width(const gs_device_t *device);
43 EXPORT uint32_t device_get_height(const gs_device_t *device);
45 device_texture_create(gs_device_t *device, uint32_t width, uint32_t height,
46  enum gs_color_format color_format, uint32_t levels,
47  const uint8_t **data, uint32_t flags);
49 device_cubetexture_create(gs_device_t *device, uint32_t size,
50  enum gs_color_format color_format, uint32_t levels,
51  const uint8_t **data, uint32_t flags);
53 device_voltexture_create(gs_device_t *device, uint32_t width, uint32_t height,
54  uint32_t depth, enum gs_color_format color_format,
55  uint32_t levels, const uint8_t *const *data,
56  uint32_t flags);
58  uint32_t width, uint32_t height,
59  enum gs_zstencil_format format);
61 device_stagesurface_create(gs_device_t *device, uint32_t width, uint32_t height,
62  enum gs_color_format color_format);
65  const struct gs_sampler_info *info);
67  const char *shader,
68  const char *file,
69  char **error_string);
71  const char *shader,
72  const char *file,
73  char **error_string);
75  struct gs_vb_data *data,
76  uint32_t flags);
78  enum gs_index_type type,
79  void *indices, size_t num,
80  uint32_t flags);
86  gs_vertbuffer_t *vertbuffer);
88  gs_indexbuffer_t *indexbuffer);
90  int unit);
92  gs_samplerstate_t *samplerstate, int unit);
94  gs_shader_t *vertshader);
96  gs_shader_t *pixelshader);
98  int unit);
104  gs_zstencil_t *zstencil);
106  gs_texture_t *cubetex, int side,
107  gs_zstencil_t *zstencil);
109  gs_texture_t *src);
111  uint32_t dst_x, uint32_t dst_y,
112  gs_texture_t *src, uint32_t src_x,
113  uint32_t src_y, uint32_t src_w,
114  uint32_t src_h);
116  gs_texture_t *src);
119 EXPORT void device_draw(gs_device_t *device, enum gs_draw_mode draw_mode,
120  uint32_t start_vert, uint32_t num_verts);
121 EXPORT void device_end_scene(gs_device_t *device);
123  gs_swapchain_t *swapchain);
124 EXPORT void device_clear(gs_device_t *device, uint32_t clear_flags,
125  const struct vec4 *color, float depth,
126  uint8_t stencil);
127 EXPORT void device_present(gs_device_t *device);
128 EXPORT void device_flush(gs_device_t *device);
129 EXPORT void device_set_cull_mode(gs_device_t *device, enum gs_cull_mode mode);
131 EXPORT void device_enable_blending(gs_device_t *device, bool enable);
132 EXPORT void device_enable_depth_test(gs_device_t *device, bool enable);
133 EXPORT void device_enable_stencil_test(gs_device_t *device, bool enable);
134 EXPORT void device_enable_stencil_write(gs_device_t *device, bool enable);
135 EXPORT void device_enable_color(gs_device_t *device, bool red, bool green,
136  bool blue, bool alpha);
138  enum gs_blend_type dest);
140  enum gs_blend_type src_c,
141  enum gs_blend_type dest_c,
142  enum gs_blend_type src_a,
143  enum gs_blend_type dest_a);
144 EXPORT void device_depth_function(gs_device_t *device, enum gs_depth_test test);
146  enum gs_stencil_side side,
147  enum gs_depth_test test);
148 EXPORT void device_stencil_op(gs_device_t *device, enum gs_stencil_side side,
149  enum gs_stencil_op_type fail,
150  enum gs_stencil_op_type zfail,
151  enum gs_stencil_op_type zpass);
152 EXPORT void device_set_viewport(gs_device_t *device, int x, int y, int width,
153  int height);
154 EXPORT void device_get_viewport(const gs_device_t *device,
155  struct gs_rect *rect);
157  const struct gs_rect *rect);
158 EXPORT void device_ortho(gs_device_t *device, float left, float right,
159  float top, float bottom, float znear, float zfar);
160 EXPORT void device_frustum(gs_device_t *device, float left, float right,
161  float top, float bottom, float znear, float zfar);
165  const char *markername,
166  const float color[4]);
168 
169 #ifdef __cplusplus
170 }
171 #endif
gs_vertbuffer_t
struct gs_vertex_buffer gs_vertbuffer_t
Definition: graphics.h:269
device_set_cull_mode
EXPORT void device_set_cull_mode(gs_device_t *device, enum gs_cull_mode mode)
device_load_indexbuffer
EXPORT void device_load_indexbuffer(gs_device_t *device, gs_indexbuffer_t *indexbuffer)
device_zstencil_create
EXPORT gs_zstencil_t * device_zstencil_create(gs_device_t *device, uint32_t width, uint32_t height, enum gs_zstencil_format format)
gs_stagesurf_t
struct gs_stage_surface gs_stagesurf_t
Definition: graphics.h:267
gs_device_t
struct gs_device gs_device_t
Definition: graphics.h:282
gs_zstencil_format
gs_zstencil_format
Definition: graphics.h:78
device_swapchain_create
EXPORT gs_swapchain_t * device_swapchain_create(gs_device_t *device, const struct gs_init_data *data)
device_set_render_target
EXPORT void device_set_render_target(gs_device_t *device, gs_texture_t *tex, gs_zstencil_t *zstencil)
device_set_viewport
EXPORT void device_set_viewport(gs_device_t *device, int x, int y, int width, int height)
device_vertexshader_create
EXPORT gs_shader_t * device_vertexshader_create(gs_device_t *device, const char *shader, const char *file, char **error_string)
device_resize
EXPORT void device_resize(gs_device_t *device, uint32_t x, uint32_t y)
gs_color_format
gs_color_format
Definition: graphics.h:56
device_get_width
EXPORT uint32_t device_get_width(const gs_device_t *device)
device_texture_create
EXPORT gs_texture_t * device_texture_create(gs_device_t *device, uint32_t width, uint32_t height, enum gs_color_format color_format, uint32_t levels, const uint8_t **data, uint32_t flags)
device_stencil_function
EXPORT void device_stencil_function(gs_device_t *device, enum gs_stencil_side side, enum gs_depth_test test)
device_get_render_target
EXPORT gs_texture_t * device_get_render_target(const gs_device_t *device)
device_set_scissor_rect
EXPORT void device_set_scissor_rect(gs_device_t *device, const struct gs_rect *rect)
device_preprocessor_name
const EXPORT char * device_preprocessor_name(void)
device_debug_marker_begin
EXPORT void device_debug_marker_begin(gs_device_t *device, const char *markername, const float color[4])
device_enable_depth_test
EXPORT void device_enable_depth_test(gs_device_t *device, bool enable)
device_load_default_samplerstate
EXPORT void device_load_default_samplerstate(gs_device_t *device, bool b_3d, int unit)
device_load_texture
EXPORT void device_load_texture(gs_device_t *device, gs_texture_t *tex, int unit)
gs_timer_range_t
struct gs_timer_range gs_timer_range_t
Definition: graphics.h:274
device_vertexbuffer_create
EXPORT gs_vertbuffer_t * device_vertexbuffer_create(gs_device_t *device, struct gs_vb_data *data, uint32_t flags)
gs_stencil_op_type
gs_stencil_op_type
Definition: graphics.h:128
gs_init_data
Definition: graphics.h:484
device_flush
EXPORT void device_flush(gs_device_t *device)
device_leave_context
EXPORT void device_leave_context(gs_device_t *device)
device_enum_adapters
EXPORT bool device_enum_adapters(bool(*callback)(void *param, const char *name, uint32_t id), void *param)
gs_index_type
gs_index_type
Definition: graphics.h:86
device_enable_stencil_write
EXPORT void device_enable_stencil_write(gs_device_t *device, bool enable)
EXPORT
#define EXPORT
Definition: c99defs.h:37
gs_timer_t
struct gs_timer gs_timer_t
Definition: graphics.h:273
device_destroy
EXPORT void device_destroy(gs_device_t *device)
gs_shader_t
struct gs_shader gs_shader_t
Definition: graphics.h:276
device_load_pixelshader
EXPORT void device_load_pixelshader(gs_device_t *device, gs_shader_t *pixelshader)
gs_indexbuffer_t
struct gs_index_buffer gs_indexbuffer_t
Definition: graphics.h:270
device_get_type
EXPORT int device_get_type(void)
device_load_vertexshader
EXPORT void device_load_vertexshader(gs_device_t *device, gs_shader_t *vertshader)
device_end_scene
EXPORT void device_end_scene(gs_device_t *device)
device_depth_function
EXPORT void device_depth_function(gs_device_t *device, enum gs_depth_test test)
device_blend_function_separate
EXPORT void device_blend_function_separate(gs_device_t *device, enum gs_blend_type src_c, enum gs_blend_type dest_c, enum gs_blend_type src_a, enum gs_blend_type dest_a)
device_timer_range_create
EXPORT gs_timer_range_t * device_timer_range_create(gs_device_t *device)
device_indexbuffer_create
EXPORT gs_indexbuffer_t * device_indexbuffer_create(gs_device_t *device, enum gs_index_type type, void *indices, size_t num, uint32_t flags)
gs_texture_t
struct gs_texture gs_texture_t
Definition: graphics.h:266
device_get_texture_type
EXPORT enum gs_texture_type device_get_texture_type(const gs_texture_t *texture)
device_projection_pop
EXPORT void device_projection_pop(gs_device_t *device)
device_stage_texture
EXPORT void device_stage_texture(gs_device_t *device, gs_stagesurf_t *dst, gs_texture_t *src)
c99defs.h
device_enable_color
EXPORT void device_enable_color(gs_device_t *device, bool red, bool green, bool blue, bool alpha)
gs_stencil_side
gs_stencil_side
Definition: graphics.h:122
gs_draw_mode
gs_draw_mode
Definition: graphics.h:48
device_get_viewport
EXPORT void device_get_viewport(const gs_device_t *device, struct gs_rect *rect)
device_present
EXPORT void device_present(gs_device_t *device)
vec3::y
float y
Definition: vec3.h:37
gs_samplerstate_t
struct gs_sampler_state gs_samplerstate_t
Definition: graphics.h:271
device_ortho
EXPORT void device_ortho(gs_device_t *device, float left, float right, float top, float bottom, float znear, float zfar)
device_get_cull_mode
EXPORT enum gs_cull_mode device_get_cull_mode(const gs_device_t *device)
device_enable_blending
EXPORT void device_enable_blending(gs_device_t *device, bool enable)
gs_sampler_info
Definition: graphics.h:223
device_samplerstate_create
EXPORT gs_samplerstate_t * device_samplerstate_create(gs_device_t *device, const struct gs_sampler_info *info)
device_copy_texture_region
EXPORT void device_copy_texture_region(gs_device_t *device, gs_texture_t *dst, uint32_t dst_x, uint32_t dst_y, gs_texture_t *src, uint32_t src_x, uint32_t src_y, uint32_t src_w, uint32_t src_h)
device_pixelshader_create
EXPORT gs_shader_t * device_pixelshader_create(gs_device_t *device, const char *shader, const char *file, char **error_string)
gs_vb_data
Definition: graphics.h:191
device_load_samplerstate
EXPORT void device_load_samplerstate(gs_device_t *device, gs_samplerstate_t *samplerstate, int unit)
device_cubetexture_create
EXPORT gs_texture_t * device_cubetexture_create(gs_device_t *device, uint32_t size, enum gs_color_format color_format, uint32_t levels, const uint8_t **data, uint32_t flags)
device_timer_create
EXPORT gs_timer_t * device_timer_create(gs_device_t *device)
device_debug_marker_end
EXPORT void device_debug_marker_end(gs_device_t *device)
device_get_zstencil_target
EXPORT gs_zstencil_t * device_get_zstencil_target(const gs_device_t *device)
gs_cull_mode
gs_cull_mode
Definition: graphics.h:91
device_copy_texture
EXPORT void device_copy_texture(gs_device_t *device, gs_texture_t *dst, gs_texture_t *src)
device_load_swapchain
EXPORT void device_load_swapchain(gs_device_t *device, gs_swapchain_t *swapchain)
device_get_device_obj
EXPORT void * device_get_device_obj(gs_device_t *device)
gs_blend_type
gs_blend_type
Definition: graphics.h:97
device_blend_function
EXPORT void device_blend_function(gs_device_t *device, enum gs_blend_type src, enum gs_blend_type dest)
device_enter_context
EXPORT void device_enter_context(gs_device_t *device)
gs_depth_test
gs_depth_test
Definition: graphics.h:111
device_clear
EXPORT void device_clear(gs_device_t *device, uint32_t clear_flags, const struct vec4 *color, float depth, uint8_t stencil)
device_projection_push
EXPORT void device_projection_push(gs_device_t *device)
device_stencil_op
EXPORT void device_stencil_op(gs_device_t *device, enum gs_stencil_side side, enum gs_stencil_op_type fail, enum gs_stencil_op_type zfail, enum gs_stencil_op_type zpass)
vec4
Definition: vec4.h:31
device_begin_frame
EXPORT void device_begin_frame(gs_device_t *device)
device_begin_scene
EXPORT void device_begin_scene(gs_device_t *device)
device_draw
EXPORT void device_draw(gs_device_t *device, enum gs_draw_mode draw_mode, uint32_t start_vert, uint32_t num_verts)
vec3::x
float x
Definition: vec3.h:37
device_get_pixel_shader
EXPORT gs_shader_t * device_get_pixel_shader(const gs_device_t *device)
gs_zstencil_t
struct gs_zstencil_buffer gs_zstencil_t
Definition: graphics.h:268
device_set_cube_render_target
EXPORT void device_set_cube_render_target(gs_device_t *device, gs_texture_t *cubetex, int side, gs_zstencil_t *zstencil)
device_frustum
EXPORT void device_frustum(gs_device_t *device, float left, float right, float top, float bottom, float znear, float zfar)
gs_texture_type
gs_texture_type
Definition: graphics.h:166
gs_swapchain_t
struct gs_swap_chain gs_swapchain_t
Definition: graphics.h:272
device_get_size
EXPORT void device_get_size(const gs_device_t *device, uint32_t *x, uint32_t *y)
device_create
EXPORT int device_create(gs_device_t **device, uint32_t adapter)
device_enable_stencil_test
EXPORT void device_enable_stencil_test(gs_device_t *device, bool enable)
device_get_name
const EXPORT char * device_get_name(void)
device_get_vertex_shader
EXPORT gs_shader_t * device_get_vertex_shader(const gs_device_t *device)
device_voltexture_create
EXPORT gs_texture_t * device_voltexture_create(gs_device_t *device, uint32_t width, uint32_t height, uint32_t depth, enum gs_color_format color_format, uint32_t levels, const uint8_t *const *data, uint32_t flags)
device_get_height
EXPORT uint32_t device_get_height(const gs_device_t *device)
gs_rect
Definition: graphics.h:239
device_stagesurface_create
EXPORT gs_stagesurf_t * device_stagesurface_create(gs_device_t *device, uint32_t width, uint32_t height, enum gs_color_format color_format)
device_load_vertexbuffer
EXPORT void device_load_vertexbuffer(gs_device_t *device, gs_vertbuffer_t *vertbuffer)