Settings

Customizable configuration data. More...

Functions
int	vmu_has_241_blocks (maple_device_t *dev)
	Get the status of a VMUs extra 41 blocks.
int	vmu_toggle_241_blocks (maple_device_t *dev, int enable)
	Enable the extra 41 blocks of a VMU.
int	vmu_use_custom_color (maple_device_t *dev, int enable)
	Enable custom color of a VMU.
int	vmu_set_custom_color (maple_device_t *dev, uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha)
	Set custom color of a VMU.
int	vmu_get_custom_color (maple_device_t *dev, uint8_t *red, uint8_t *green, uint8_t *blue, uint8_t *alpha)
	Get custom color of a VMU.
int	vmu_set_icon_shape (maple_device_t *dev, uint8_t icon_shape)
	Set icon shape of a VMU.
int	vmu_get_icon_shape (maple_device_t *dev, uint8_t *icon_shape)
	Get icon shape of a VMU.

Detailed Description

Customizable configuration data.

This module provides a high-level abstraction around various features and settings which can be modified on the VMU. Many of these operations are provided by the Dreamcast's BIOS when a VMU has been formatted.

Function Documentation

vmu_get_custom_color()

int vmu_get_custom_color	(	maple_device_t *	dev,
		uint8_t *	red,
		uint8_t *	green,
		uint8_t *	blue,
		uint8_t *	alpha
	)

Get custom color of a VMU.

This function gets the custom color of a specific VMU. This color is only displayed in the Dreamcast's file manager. This function also returns whether the custom color is currently enabled.

Parameters

dev	The device to change the color of.
red	The red component. 0-255
green	The green component. 0-255
blue	The blue component. 0-255
alpha	The alpha component. 0-255; 100-255 Recommended

Return values

1	On success: custom color is enabled
0	On success: custom color is disabled
-1	On failure

See also

vmu_set_custom_color, vmu_use_custom_color

vmu_get_icon_shape()

int vmu_get_icon_shape	(	maple_device_t *	dev,
		uint8_t *	icon_shape
	)

Get icon shape of a VMU.

This function gets the icon shape of a specific VMU. The icon shape is a VMU icon that is displayed on the LCD screen while navigating the Dreamcast BIOS menu and is the GUI representation of the VMU in the menu's file manager. The Dreamcast BIOS provides a set of 124 icons to choose from.

Note

When a custom file named "ICONDATA_VMS" is present on a VMU, it overrides this icon by providing custom icons for both the DC BIOS menu and the VMU's LCD screen.

Parameters

dev	The device to change the icon shape of.
icon_shape	One of the values found in Builtin VMU Icons.

Return values

0	On success
-1	On failure

See also

Builtin VMU Icons, vmu_set_icon_shape

vmu_has_241_blocks()

int vmu_has_241_blocks

(

maple_device_t *

dev

)

Get the status of a VMUs extra 41 blocks.

This function checks if the extra 41 blocks of a VMU have been enabled.

Parameters

dev	The device to check the status of.

Return values

1	On success: extra blocks are enabled
0	On success: extra blocks are disabled
-1	On failure

vmu_set_custom_color()

int vmu_set_custom_color	(	maple_device_t *	dev,
		uint8_t	red,
		uint8_t	green,
		uint8_t	blue,
		uint8_t	alpha
	)

Set custom color of a VMU.

This function sets the custom color of a specific VMU. This color is only displayed in the Dreamcast's file manager. This function also enables the use of the custom color. Otherwise it wouldn't show up.

Parameters

dev	The device to change the color of.
red	The red component. 0-255
green	The green component. 0-255
blue	The blue component. 0-255
alpha	The alpha component. 0-255; 100-255 Recommended

Return values

0	On success
-1	On failure

See also

vmu_get_custom_color, vmu_use_custom_color

vmu_set_icon_shape()

int vmu_set_icon_shape	(	maple_device_t *	dev,
		uint8_t	icon_shape
	)

Set icon shape of a VMU.

This function sets the icon shape of a specific VMU. The icon shape is a VMU icon that is displayed on the LCD screen while navigating the Dreamcast BIOS menu and is the GUI representation of the VMU in the menu's file manager. The Dreamcast BIOS provides a set of 124 icons to choose from.

Note

When a custom file named "ICONDATA_VMS" is present on a VMU, it overrides this icon by providing custom icons for both the DC BIOS menu and the VMU's LCD screen.

Parameters

dev	The device to change the icon shape of.
icon_shape	One of the values found in Builtin VMU Icons.

Return values

0	On success
-1	On failure

See also

Builtin VMU Icons, vmu_get_icon_shape

vmu_toggle_241_blocks()

int vmu_toggle_241_blocks	(	maple_device_t *	dev,
		int	enable
	)

Enable the extra 41 blocks of a VMU.

This function enables/disables the extra 41 blocks of a specific VMU.

Warning

Enabling the extra blocks of a VMU may render it unusable for a very few commercial games.

Parameters

dev	The device to enable/disable 41 blocks.
enable	Values other than 0 enables. Equal to 0 disables.

Return values

0	On success
-1	On failure

vmu_use_custom_color()

int vmu_use_custom_color	(	maple_device_t *	dev,
		int	enable
	)

Enable custom color of a VMU.

This function enables/disables the custom color of a specific VMU. This color is only displayed in the Dreamcast's file manager.

Parameters

dev	The device to enable/disable custom color.
enable	Values other than 0 enables. Equal to 0 disables.

Return values

0	On success
-1	On failure

See also

vmu_set_custom_color