Jo Engine 2026.11.1
Jo Sega Saturn Engine
Loading...
Searching...
No Matches
video.h
Go to the documentation of this file.
1/*
2** Jo Sega Saturn Engine
3** Copyright (c) 2012-2026, Johannes Fetz (johannesfetz@gmail.com)
4** All rights reserved.
5**
6** Redistribution and use in source and binary forms, with or without
7** modification, are permitted provided that the following conditions are met:
8** * Redistributions of source code must retain the above copyright
9** notice, this list of conditions and the following disclaimer.
10** * Redistributions in binary form must reproduce the above copyright
11** notice, this list of conditions and the following disclaimer in the
12** documentation and/or other materials provided with the distribution.
13** * Neither the name of the Johannes Fetz nor the
14** names of its contributors may be used to endorse or promote products
15** derived from this software without specific prior written permission.
16**
17** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY
21** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27*/
37
38#ifndef __JO_VIDEO_H__
39# define __JO_VIDEO_H__
40
41#ifdef JO_COMPILE_WITH_VIDEO_SUPPORT
42
43/*
44** TYPEDEFS
45*/
47typedef void (*jo_video_onstop_callback)(void);
48
52extern int __jo_video_sprite_id;
53
58bool jo_video_open_file(const char *const filename);
59
64
69bool jo_video_pause(void);
70
74void jo_video_stop(void);
75
81{
82 return (__jo_video_sprite_id);
83}
84
85#endif /* !JO_COMPILE_WITH_VIDEO_SUPPORT */
86
87#endif /* !__JO_VIDEO_H__ */
88
89/*
90** END OF FILE
91*/
#define __jo_force_inline
force inline attribute (and prevent Doxygen prototype parsing bug)
Definition types.h:39
void jo_video_stop(void)
Stop the movie (must be called after jo_video_play()).
bool jo_video_play(const jo_video_onstop_callback onstop)
Play the movie previously loaded.
static __jo_force_inline int jo_get_video_sprite(void)
Get video sprite Id.
Definition video.h:80
void(*) jo_video_onstop_callback(void)
Function prototype for jo_video_play().
Definition video.h:47
bool jo_video_pause(void)
Pause the movie (must be called after jo_video_play()).
bool jo_video_open_file(const char *const filename)
Open a Sega FILM / Cinepak.
int __jo_video_sprite_id
Error handling (Internal usage).