libdragon
Loading...
Searching...
No Matches
Files | Functions
PixelFX integration routines

Functions for integrating with PixelFX console mods. More...

Files

file  pixelfx.c
 PixelFX integration routines.
 
file  pixelfx.h
 PixelFX integration routines.
 

Functions

void pixelfx_send_game_id (uint64_t rom_check_code, uint8_t media_format, uint8_t region_code)
 Notifies the PixelFX console mod of the current Game ID.
 
void pixelfx_clear_game_id (void)
 Notifies the PixelFX console mod to clear the current Game ID.
 

Detailed Description

Functions for integrating with PixelFX console mods.

N64Digital and Retro GEM allow per-game settings when ROM metadata is broadcast over Joybus. This module provides functions to easily set and reset the "Game ID" to tell the console mod which game settings to use.

See also
https://gitlab.com/pixelfx-public/n64-game-id

Function Documentation

◆ pixelfx_send_game_id()

void pixelfx_send_game_id ( uint64_t  rom_check_code,
uint8_t  media_format,
uint8_t  region_code 
)

Notifies the PixelFX console mod of the current Game ID.

This function is mostly intended to be used by flashcart menu software or by software that will be flashed onto single-ROM flash cartridges.

See also
https://gitlab.com/pixelfx-public/n64-game-id#n64-game-id-per-game-settings-for-n64digital
Parameters
rom_check_codeROM check code (ROM header bytes 0x10-0x17)
media_formatMedia category code (ROM header byte 0x3B)
region_codeRegion code (ROM header byte 0x3E)

◆ pixelfx_clear_game_id()

void pixelfx_clear_game_id ( void  )

Notifies the PixelFX console mod to clear the current Game ID.

This function is mostly intended to be used by flashcart menu software or by software that will be flashed onto single-ROM flash cartridges.

See also
https://gitlab.com/pixelfx-public/n64-game-id#special-ids