mirror of
https://github.com/libretro/RetroArch.git
synced 2024-12-05 06:57:19 +00:00
28bb7c67af
Move thumbnail path handling code to reusable menu_thumbnail_path.h/.c file (XMB) Bug fixes: - Show thumbnails correctly when 'Show associated cores in playlists' is enabled - Prevent each thumbnail from being loaded twice (!) when changing current selection
130 lines
5.0 KiB
C
130 lines
5.0 KiB
C
/* Copyright (C) 2010-2019 The RetroArch team
|
|
*
|
|
* ---------------------------------------------------------------------------------------
|
|
* The following license statement only applies to this file (runtime_file.c).
|
|
* ---------------------------------------------------------------------------------------
|
|
*
|
|
* Permission is hereby granted, free of charge,
|
|
* to any person obtaining a copy of this software and associated documentation files (the "Software"),
|
|
* to deal in the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
|
|
* and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
|
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef __MENU_THUMBNAIL_PATH_H
|
|
#define __MENU_THUMBNAIL_PATH_H
|
|
|
|
#include <retro_common_api.h>
|
|
#include <libretro.h>
|
|
|
|
#include <boolean.h>
|
|
|
|
#include "../playlist.h"
|
|
|
|
RETRO_BEGIN_DECLS
|
|
|
|
/* Note: This implementation reflects the current
|
|
* setup of:
|
|
* - menu_driver_set_thumbnail_system()
|
|
* - menu_driver_set_thumbnail_content()
|
|
* - menu_driver_update_thumbnail_path()
|
|
* This is absolutely not the best way to handle things,
|
|
* but I have no interest in rewriting the existing
|
|
* menu code... */
|
|
|
|
enum menu_thumbnail_id
|
|
{
|
|
MENU_THUMBNAIL_RIGHT = 0,
|
|
MENU_THUMBNAIL_LEFT
|
|
};
|
|
|
|
/* Prevent direct access to menu_thumbnail_path_data_t members */
|
|
typedef struct menu_thumbnail_path_data menu_thumbnail_path_data_t;
|
|
|
|
/* Initialisation */
|
|
|
|
/* Creates new thumbnail path data container.
|
|
* Returns handle to new menu_thumbnail_path_data_t object.
|
|
* on success, otherwise NULL.
|
|
* Note: Returned object must be free()d */
|
|
menu_thumbnail_path_data_t *menu_thumbnail_path_init();
|
|
|
|
/* Resets thumbnail path data
|
|
* (blanks all internal string containers) */
|
|
void menu_thumbnail_path_reset(menu_thumbnail_path_data_t *path_data);
|
|
|
|
/* Utility Functions */
|
|
|
|
/* Returns currently set thumbnail 'type' (Named_Snaps,
|
|
* Named_Titles, Named_Boxarts) for specified thumbnail
|
|
* identifier (right, left) */
|
|
const char *menu_thumbnail_get_type(enum menu_thumbnail_id thumbnail_id);
|
|
|
|
/* Returns true if specified thumbnail is enabled
|
|
* (i.e. if 'type' is not equal to MENU_ENUM_LABEL_VALUE_OFF) */
|
|
bool menu_thumbnail_is_enabled(enum menu_thumbnail_id thumbnail_id);
|
|
|
|
/* Setters */
|
|
|
|
/* Sets current 'system' (default database name).
|
|
* Returns true if 'system' is valid.
|
|
* > Used as a fallback when individual content lacks an
|
|
* associated database name */
|
|
bool menu_thumbnail_set_system(menu_thumbnail_path_data_t *path_data, const char *system);
|
|
|
|
/* Sets current thumbnail content according to the specified label.
|
|
* Returns true if content is valid */
|
|
bool menu_thumbnail_set_content(menu_thumbnail_path_data_t *path_data, const char *label);
|
|
|
|
/* Sets current thumbnail content to the specified image.
|
|
* Returns true if content is valid */
|
|
bool menu_thumbnail_set_content_image(menu_thumbnail_path_data_t *path_data, const char *img_dir, const char *img_name);
|
|
|
|
/* Sets current thumbnail content to the specified playlist entry.
|
|
* Returns true if content is valid.
|
|
* > Note: It is always best to use playlists when setting
|
|
* thumbnail content, since there is no guarantee that the
|
|
* corresponding menu entry label will contain a useful
|
|
* identifier (it may be 'tainted', e.g. with the current
|
|
* core name). 'Real' labels should be extracted from source */
|
|
bool menu_thumbnail_set_content_playlist(menu_thumbnail_path_data_t *path_data, playlist_t *playlist, size_t idx);
|
|
|
|
/* Updaters */
|
|
|
|
/* Updates path for specified thumbnail identifier (right, left).
|
|
* Must be called after:
|
|
* - menu_thumbnail_set_system()
|
|
* - menu_thumbnail_set_content*()
|
|
* ...and before:
|
|
* - menu_thumbnail_get_path()
|
|
* Returns true if generated path is valid */
|
|
bool menu_thumbnail_update_path(menu_thumbnail_path_data_t *path_data, enum menu_thumbnail_id thumbnail_id);
|
|
|
|
/* Getters */
|
|
|
|
/* Fetches the current thumbnail file path of the
|
|
* specified thumbnail 'type'.
|
|
* Returns true if path is valid. */
|
|
bool menu_thumbnail_get_path(menu_thumbnail_path_data_t *path_data, enum menu_thumbnail_id thumbnail_id, const char **path);
|
|
|
|
/* Fetches current thumbnail label.
|
|
* Returns true if label is valid. */
|
|
bool menu_thumbnail_get_label(menu_thumbnail_path_data_t *path_data, const char **label);
|
|
|
|
/* Fetches current thumbnail core name.
|
|
* Returns true if core name is valid. */
|
|
bool menu_thumbnail_get_core_name(menu_thumbnail_path_data_t *path_data, const char **core_name);
|
|
|
|
RETRO_END_DECLS
|
|
|
|
#endif
|