Ylva And Malin
ym_gfx.h
Go to the documentation of this file.
1 #pragma once
2 #include <stdbool.h>
3 
4 #include <ym_core.h>
5 #include <ym_memory.h>
6 
22 typedef void ym_gfx_window;
23 
48 YM_NO_DISCARD
49 ym_errc
50 ym_gfx_init(ym_mem_reg_id memory_region);
51 
67 YM_NO_DISCARD
68 ym_errc
69 ym_gfx_shutdown();
70 
103 YM_NO_DISCARD
104 ym_errc
105 ym_gfx_create_window(u16 width,
106  u16 height,
107  const char* window_name,
108  ym_gfx_window** out_window);
109 
121 void
122 ym_gfx_destroy_window(ym_gfx_window* window);
123 
139 YM_NO_DISCARD
140 bool
141 ym_gfx_window_is_open(const ym_gfx_window* window);
142 
159 void
160 ym_gfx_window_get_size(ym_gfx_window* window,
161  uint* out_width,
162  uint* out_height);
163 
164 
174 void
175 ym_gfx_window_clear(ym_gfx_window* window);
176 
191 void
192 ym_gfx_window_display(ym_gfx_window* window);
193 
208 void
209 ym_gfx_window_poll_events(ym_gfx_window* window);
ym_gfx_window_is_open
YM_NO_DISCARD bool ym_gfx_window_is_open(const ym_gfx_window *window)
Checks if the current supplied window is open, or if it has been closed.
Definition: ym_gfx_unix.c:264
height
int int int int height
Definition: wglext.h:61
width
int int int width
Definition: wglext.h:61
ym_core.h
YM_NO_DISCARD
#define YM_NO_DISCARD
YM_NO_DISCARD is a platform independent macro informing the compiler to warn if a return value from a...
Definition: ym_attributes.h:94
ym_gfx_window_get_size
void ym_gfx_window_get_size(ym_gfx_window *window, uint *out_width, uint *out_height)
Gets the width and height dimension of the given window.
Definition: ym_gfx_unix.c:274
ym_gfx_create_window
YM_NO_DISCARD ym_errc ym_gfx_create_window(u16 width, u16 height, const char *window_name, ym_gfx_window **out_window)
Creates a ym_gfx_window with the specified width, height, and name.
Definition: ym_gfx_unix.c:86
u16
uint16_t u16
Definition: ym_types.h:9
ym_gfx_window_display
void ym_gfx_window_display(ym_gfx_window *window)
Displays everything that has been rendered to the window.
Definition: ym_gfx_unix.c:297
ym_errc
ym_errc
Used to indicate erroneous behavior within a a function.
Definition: ym_error.h:36
ym_gfx_shutdown
YM_NO_DISCARD ym_errc ym_gfx_shutdown()
Finished the last of de-initialization needed by the ym_gfx module.
Definition: ym_gfx_unix.c:79
ym_mem_reg_id
ym_mem_reg_id
Definition: ym_memory_regions.h:30
ym_memory.h
ym_gfx_window_clear
void ym_gfx_window_clear(ym_gfx_window *window)
Clears the given window.
ym_gfx_window
void ym_gfx_window
Simple typedef for void, as no direct handling of the window is legal.
Definition: ym_gfx.h:22
ym_gfx_init
YM_NO_DISCARD ym_errc ym_gfx_init(ym_mem_reg_id memory_region)
Initializes the ym_gfx module with a given memory region.
Definition: ym_gfx_unix.c:72
ym_gfx_window_poll_events
void ym_gfx_window_poll_events(ym_gfx_window *window)
Polls events tied to the window in question.
Definition: ym_gfx_unix.c:308
uint
unsigned uint
Definition: ym_types.h:22
ym_gfx_destroy_window
void ym_gfx_destroy_window(ym_gfx_window *window)
Destroys/deallocates the window pointed to by window.
Definition: ym_gfx_unix.c:245
Generated by   doxygen 1.8.11