amino
Lightweight Robot Utility Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
scene_sdl.h
Go to the documentation of this file.
1 /* -*- mode: C; c-basic-offset: 4; -*- */
2 /* ex: set shiftwidth=4 tabstop=4 expandtab: */
3 /*
4  * Copyright (c) 2015, Rice University
5  * All rights reserved.
6  *
7  * Author(s): Neil T. Dantam <ntd@rice.edu>
8  *
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of copyright holder the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
23  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
24  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
27  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
30  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
31  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  */
37 
38 #ifndef AMINO_RX_SCENE_SDL_H
39 #define AMINO_RX_SCENE_SDL_H
40 
70 AA_API void aa_sdl_init( void );
71 
72 AA_API void aa_sdl_scroll(
73  struct aa_gl_globals * globals,
74  int *update, int *quit );
75 
76 
77 AA_API void aa_sdl_display_loop(
78  SDL_Window* window,
79  struct aa_gl_globals * globals,
80  aa_sdl_display_fun display,
81  void *context );
82 
83 
84 
85 AA_API void aa_sdl_gl_window(
86  const char* title,
87  int x_pos,
88  int y_pos,
89  int width,
90  int height,
91  Uint32 flags,
92  SDL_Window **pwindow,
93  SDL_GLContext *p_glcontext );
94 
95 AA_API const struct timespec *
96 aa_sdl_display_params_get_time_now( struct aa_sdl_display_params *params );
97 
98 AA_API const struct timespec *
99 aa_sdl_display_params_get_time_last( struct aa_sdl_display_params *params );
100 
101 AA_API const struct timespec *
102 aa_sdl_display_params_get_time_initial( struct aa_sdl_display_params *params );
103 
104 AA_API int
105 aa_sdl_display_params_get_update( struct aa_sdl_display_params *params );
106 
107 AA_API void
108 aa_sdl_display_params_set_quit( struct aa_sdl_display_params *params );
109 
110 AA_API void
111 aa_sdl_display_params_set_update( struct aa_sdl_display_params *params );
112 
113 AA_API int
114 aa_sdl_display_params_is_first( struct aa_sdl_display_params *params );
115 
116 #endif /*AMINO_RX_SCENE_SDL_H*/
aa_sdl_init
AA_API void aa_sdl_init(void)
Initialize SDL library and options.
aa_sdl_display_fun
int(* aa_sdl_display_fun)(void *context, struct aa_sdl_display_params *params)
Display handler function to call in SDL loop.
Definition: rxtype.h:90
AA_API
#define AA_API
calling and name mangling convention for functions
Definition: amino.h:95
aa_sdl_display_params
Parameters for SDL display function.
Definition: rxtype.h:74