MPDLConfig

Definitions


#include <revolution/mpdl.h>

typedef struct MPDLConfig
{
    void*       (*alloc)(u32 size);
    void        (*free) (void* ptr);
    OSPriority  threadPriority;
    u32         ggid;
    u32         tgid;
    u32         channel;

    u8          serverColor;
    const u16  *serverName;
    const u16  *programTitle;
    const u16  *programComment;
    u32         programMaxEntry;
    const u8   *programImage;
    const void *bannerCharacter;
    const void *bannerPalette;

    void       *internalWork1;
    void       *internalWork2;
    BOOL        entry_flag;
    BOOL        mb_flag;
    u32         bitmap;
    MPConfig    mpConfig[1];
}
MPDLConfig;

Description

The MPDLConfig structure is used to store MPDL library settings and configuration information for the MP library that is automatically controlled internally.

Member Description
Members used "as is" for the MP library's MPConfig
alloc Function to allocate memory for use inside the project.
free Function to deallocate memory used inside the project.
threadPriority Priority level of MP working thread.
Several working threads are created having this priority level or lower.
ggid Game Group ID (GGID) provided by Nintendo for each title with MP communications capability.
tgid 16-bit ID that must be generated each time a parent is started.
An appropriate value is automatically assigned using MP_TGID_AUTO.
channel The wireless channel to use.
MP_CHANNEL_AUTO is normally specified so the appropriate channel is selected automatically.
Members specific to the MPDL library
serverColor Any color number from 0 to 15 of your choosing to be used when displaying the DS download play program on the Nintendo DS system.
serverName The name for the server operator that will be displayed by the DS Download Play program on the Nintendo DS.
The name must be specified as a Unicode (UTF16-LE) character string of no more than 10 characters (excluding the termination character).
Note: This can be denoted in CodeWarrior with L"(string)".
programTitle The name for the program title that will be displayed by the DS Download Play program on the Nintendo DS.
The name must be specified as a Unicode (UTF16-LE) character string of no more than 48 characters (excluding the termination character).
Note: This can be denoted in CodeWarrior with L"(string)".
programComment The description of the program that will be displayed by the DS Download Play program on the Nintendo DS.
The text must be specified as a Unicode (UTF16-LE) character string of no more than 96 characters (excluding the termination character).
Note: This can be denoted in CodeWarrior with L"(string)".
programMaxEntry Maximum number of persons a session will allow for simultaneous connection. Can take any value between 2 and 16.
Note that the parent device itself is included in the count.
programImage Pointer to the memory where the Nintendo DS program to be distributed is loaded.
bannerCharacter
bannerPalette
The character data and palette data for the icon image that will be used for display by the DS Download Play program on the Nintendo DS.
This icon image consists of 16 colors of palette data and 32 x 32 dots of image data.
If the data are omitted by specifying NULL, the banner image recorded in the Nintendo DS program itself is utilized for display.
internalWork1 (Used internally by the library.)
internalWork2
entry_flag
mb_flag
bitmap
mpConfig

See Also

MPDLStartup(), MPDLCleanup()

Revision History

2007/10/11 Added member relating to banner image.
2007/05/07 Changed the maximum value of settings.
2007/05/02 Added a description of MP_CHANNEL_AUTO to channel.
2006/08/15 Added a note to indicate that the parent device is included in programMaxEntry.
2006/07/13 Added members to structure definition.
2006/07/04 Initial version.


CONFIDENTIAL