CTR-Pia
5.4.3
Game Communication Engine
メインページ
ネームスペース一覧
クラス構成
クラス索引
関連ページ
Result 検索
全て
クラス
ネームスペース
関数
変数
型定義
列挙型
列挙型の値
ページ
framework_Api.h
1
/*--------------------------------------------------------------------------------*
2
Copyright (C)Nintendo All rights reserved.
3
4
These coded instructions, statements, and computer programs contain proprietary
5
information of Nintendo and/or its licensed developers and are protected by
6
national and international copyright laws. They may not be disclosed to third
7
parties or copied or duplicated in any form, in whole or in part, without the
8
prior written consent of Nintendo.
9
10
The content herein is highly confidential and should be handled accordingly.
11
*--------------------------------------------------------------------------------*/
12
13
14
#pragma once
15
16
#include <nn/pia/framework/framework_Definitions.h>
17
18
/*!
19
framework モジュールの非メンバ関数群です。
20
*/
21
namespace
nn
22
{
23
namespace
pia
24
{
25
namespace
framework
26
{
27
/*!
28
@cond PRIVATE
29
@brief Initialize() に各種パラメータを渡すための構造体です。
30
*/
31
struct
CommonSetting
32
{
33
uint8_t* pPiaHeapBuffer;
34
uint32_t szPiaHeapBufferSize;
35
uint32_t cachedPrintBufferSize;
36
};
37
//! @endcond
38
39
/*!
40
@brief framework モジュールを初期化します。
41
@param[in] setting framework の初期化に必要なパラメータです。
42
@return 無事に初期化が完了すれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
43
@retval ResultInvalidState この関数を呼び出すタイミングが誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
44
@retval ResultAlreadyInitialized 既に初期化が完了しています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
45
@retval ResultInvalidArgument 引数が誤っています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
46
*/
47
Result
Initialize
(
const
InitializeFrameworkSetting
& setting);
48
49
/*!
50
@brief framework モジュールを終了します。
51
@details framework モジュールが初期化されていない状態の時にこの API を呼び出した場合は、何もしません。
52
*/
53
void
Finalize
();
54
55
/*!
56
@brief framework モジュールが初期化された状態であるかどうかを返します。
57
@retval true 初期化されている。
58
@retval false 初期化されていない。
59
*/
60
bool
IsInitialized
();
61
62
/*!
63
@cond PRIVATE
64
@brief BeginSetup() ~ EndSetup() 間の状態であるかどうかを返します。
65
*/
66
bool
IsInSetupMode();
67
//! @endcond
68
69
/*!
70
@cond PRIVATE
71
@brief common 初期化処理です。
72
@param[in] setting 各種パラメータが書き込まれた Setting 構造体です。
73
@return 成功すれば、 IsSuccess() が true を返す Result が返されます。
74
*/
75
Result
InitializeCommon(
const
CommonSetting& setting);
76
//! @endcond
77
78
/*!
79
@cond PRIVATE
80
@brief common 終了処理です。
81
*/
82
void
FinalizeCommon();
83
//! @endcond
84
85
}
86
}
87
}
// end of namespace nn::pia::framework
Include
nn
pia
framework
framework_Api.h
© 2016 Nintendo Co., Ltd. All rights reserved. 記載されている会社名、製品名等は、各社の登録商標または商標です。