input_overlay.h File Reference

#include <stdint.h>
#include <boolean.h>
#include <retro_common_api.h>
#include <retro_miscellaneous.h>
#include <formats/image.h>
#include "input_driver.h"

Include dependency graph for input_overlay.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	video_overlay_interface
struct	overlay
struct	overlay_desc
struct	overlay_task_data_t

Typedefs
typedef RETRO_BEGIN_DECLS struct video_overlay_interface	video_overlay_interface_t
typedef struct overlay_desc	overlay_desc_t
typedef struct input_overlay	input_overlay_t

Enumerations
enum	overlay_hitbox { OVERLAY_HITBOX_RADIAL = 0, OVERLAY_HITBOX_RECT }
enum	overlay_type { OVERLAY_TYPE_BUTTONS = 0, OVERLAY_TYPE_ANALOG_LEFT, OVERLAY_TYPE_ANALOG_RIGHT, OVERLAY_TYPE_KEYBOARD }
enum	overlay_status {   OVERLAY_STATUS_NONE = 0, OVERLAY_STATUS_DEFERRED_LOAD, OVERLAY_STATUS_DEFERRED_LOADING_IMAGE, OVERLAY_STATUS_DEFERRED_LOADING_IMAGE_PROCESS,   OVERLAY_STATUS_DEFERRED_LOADING, OVERLAY_STATUS_DEFERRED_LOADING_RESOLVE, OVERLAY_STATUS_DEFERRED_DONE, OVERLAY_STATUS_DEFERRED_ERROR }
enum	overlay_image_transfer_status {   OVERLAY_IMAGE_TRANSFER_NONE = 0, OVERLAY_IMAGE_TRANSFER_BUSY, OVERLAY_IMAGE_TRANSFER_DONE, OVERLAY_IMAGE_TRANSFER_DESC_IMAGE_ITERATE,   OVERLAY_IMAGE_TRANSFER_DESC_ITERATE, OVERLAY_IMAGE_TRANSFER_DESC_DONE, OVERLAY_IMAGE_TRANSFER_ERROR }
enum	overlay_visibility { OVERLAY_VISIBILITY_DEFAULT = 0, OVERLAY_VISIBILITY_VISIBLE, OVERLAY_VISIBILITY_HIDDEN }

Functions
void	input_overlay_free (input_overlay_t *ol)
void	input_overlay_free_overlay (struct overlay *overlay)
void	input_overlay_init (void)
void	input_overlay_set_alpha_mod (input_overlay_t *ol, float mod)
void	input_overlay_set_scale_factor (input_overlay_t *ol, float scale)
void	input_overlay_next (input_overlay_t *ol, float opacity)
void	input_poll_overlay (input_overlay_t *ol, float opacity, unsigned analog_dpad_mode, float axis_threshold)
void	input_state_overlay (input_overlay_t *ol, int16_t *ret, unsigned port, unsigned device, unsigned idx, unsigned id)
bool	input_overlay_key_pressed (input_overlay_t *ol, unsigned key)
bool	input_overlay_is_alive (input_overlay_t *ol)
void	input_overlay_loaded (void *task_data, void *user_data, const char *err)
void	input_overlay_set_visibility (int overlay_idx, enum overlay_visibility vis)

Variables
input_overlay_t *	overlay_ptr

Typedef Documentation

input_overlay_t

typedef struct input_overlay input_overlay_t

overlay_desc_t

typedef struct overlay_desc overlay_desc_t

video_overlay_interface_t

typedef RETRO_BEGIN_DECLS struct video_overlay_interface video_overlay_interface_t

Enumeration Type Documentation

overlay_hitbox

enum overlay_hitbox

Enumerator
OVERLAY_HITBOX_RADIAL
OVERLAY_HITBOX_RECT

overlay_image_transfer_status

enum overlay_image_transfer_status

Enumerator
OVERLAY_IMAGE_TRANSFER_NONE
OVERLAY_IMAGE_TRANSFER_BUSY
OVERLAY_IMAGE_TRANSFER_DONE
OVERLAY_IMAGE_TRANSFER_DESC_IMAGE_ITERATE
OVERLAY_IMAGE_TRANSFER_DESC_ITERATE
OVERLAY_IMAGE_TRANSFER_DESC_DONE
OVERLAY_IMAGE_TRANSFER_ERROR

overlay_status

enum overlay_status

Enumerator
OVERLAY_STATUS_NONE
OVERLAY_STATUS_DEFERRED_LOAD
OVERLAY_STATUS_DEFERRED_LOADING_IMAGE
OVERLAY_STATUS_DEFERRED_LOADING_IMAGE_PROCESS
OVERLAY_STATUS_DEFERRED_LOADING
OVERLAY_STATUS_DEFERRED_LOADING_RESOLVE
OVERLAY_STATUS_DEFERRED_DONE
OVERLAY_STATUS_DEFERRED_ERROR

overlay_type

enum overlay_type

Enumerator
OVERLAY_TYPE_BUTTONS
OVERLAY_TYPE_ANALOG_LEFT
OVERLAY_TYPE_ANALOG_RIGHT
OVERLAY_TYPE_KEYBOARD

overlay_visibility

enum overlay_visibility

Enumerator
OVERLAY_VISIBILITY_DEFAULT
OVERLAY_VISIBILITY_VISIBLE
OVERLAY_VISIBILITY_HIDDEN

Function Documentation

input_overlay_free()

void input_overlay_free

(

input_overlay_t *

ol

)

input_overlay_free:

Frees overlay handle.

input_overlay_free: : Overlay handle.

Frees overlay handle.

Here is the call graph for this function:

Here is the caller graph for this function:

input_overlay_free_overlay()

void input_overlay_free_overlay

(

struct overlay *

overlay

)

Here is the call graph for this function:

Here is the caller graph for this function:

input_overlay_init()

void input_overlay_init

(

void

)

input_overlay_init

Initializes the overlay system.

input_overlay_is_alive()

bool input_overlay_is_alive

(

input_overlay_t *

ol

)

Here is the caller graph for this function:

input_overlay_key_pressed()

bool input_overlay_key_pressed	(	input_overlay_t *	ol,
		unsigned	key
	)

Here is the caller graph for this function:

input_overlay_loaded()

void input_overlay_loaded	(	void *	task_data,
		void *	user_data,
		const char *	err
	)

Here is the call graph for this function:

Here is the caller graph for this function:

input_overlay_next()

void input_overlay_next	(	input_overlay_t *	ol,
		float	opacity
	)

input_overlay_next:

Switch to the next available overlay screen.

input_overlay_next: : Overlay handle.

Switch to the next available overlay screen.

Here is the call graph for this function:

Here is the caller graph for this function:

input_overlay_set_alpha_mod()

void input_overlay_set_alpha_mod	(	input_overlay_t *	ol,
		float	mod
	)

input_overlay_set_alpha_mod: : New modulating factor to apply.

Sets a modulating factor for alpha channel. Default is 1.0. The alpha factor is applied for all overlays.

input_overlay_set_alpha_mod: : Overlay handle. : New modulating factor to apply.

Sets a modulating factor for alpha channel. Default is 1.0. The alpha factor is applied for all overlays.

Here is the call graph for this function:

Here is the caller graph for this function:

input_overlay_set_scale_factor()

void input_overlay_set_scale_factor	(	input_overlay_t *	ol,
		float	scale
	)

input_overlay_set_scale_factor: : Factor of scale to apply.

Scales the overlay by a factor of scale.

input_overlay_set_scale_factor: : Overlay handle. : Factor of scale to apply.

Scales the overlay by a factor of scale.

Here is the call graph for this function:

Here is the caller graph for this function:

input_overlay_set_visibility()

void input_overlay_set_visibility	(	int	overlay_idx,
		enum overlay_visibility	vis
	)

Here is the caller graph for this function:

input_poll_overlay()

void input_poll_overlay	(	input_overlay_t *	ol,
		float	opacity,
		unsigned	analog_dpad_mode,
		float	axis_threshold
	)

Here is the call graph for this function:

Here is the caller graph for this function:

input_state_overlay()

void input_state_overlay	(	input_overlay_t *	ol,
		int16_t *	ret,
		unsigned	port,
		unsigned	device,
		unsigned	idx,
		unsigned	id
	)

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

overlay_ptr

input_overlay_t* overlay_ptr