GameCanvas

Appearance

インターフェイス IGameCanvas ​

Namespace: GameCanvas

csharp
public interface IGameCanvas : IGraphicsEx, ISoundEx, INetworkEx, ISceneManagementEx, ITimeEx, IPhysicsEx, IStorageEx, IMathEx, IInputPointerEx, IInputKeyEx, IInputAccelerationEx, IInputGeolocationEx, IInputCameraEx

継承元

プロパティ ​

AccelerationEventCount ​

継承元: IInputAcceleration

csharp
int AccelerationEventCount { get; }

前回のフレーム処理以降に検出した 加速度イベントの数

AccelerationEvents ​

継承元: IInputAcceleration

csharp
System.ReadOnlySpan<GcAccelerationEvent> AccelerationEvents { get; }

前回のフレーム処理以降に検出した 加速度イベントの列挙子

AccelerometerSamplingRate ​

継承元: IInputAcceleration

csharp
float AccelerometerSamplingRate { get; set; }

加速度計の動作周波数

BackgroundColor ​

継承元: IGraphics

csharp
Color BackgroundColor { get; set; }

背景色

BorderColor ​

継承元: IGraphics

csharp
Color BorderColor { get; }

キャンバス外に表示される帯の色

備考

ChangeBorderColor を呼び出すことで変更できます

CameraDeviceCount ​

継承元: IInputCamera

csharp
int CameraDeviceCount { get; }

認識可能なカメラ（外部入力映像）の数

CameraDevices ​

継承元: IInputCamera

csharp
System.ReadOnlySpan<GcCameraDevice> CameraDevices { get; }

全ての認識可能なカメラ（外部入力映像）の一覧

CanvasAABB ​

継承元: IGraphicsEx

csharp
GcAABB CanvasAABB { get; }

キャンバスのAABB

CanvasCenter ​

継承元: IGraphicsEx

csharp
float2 CanvasCenter { get; }

キャンバスの中心座標

CanvasHeight ​

継承元: IGraphicsEx

csharp
int CanvasHeight { get; }

キャンバスの縦幅

CanvasResolution ​

継承元: IGraphicsEx

csharp
GcResolution CanvasResolution { get; }

キャンバスの解像度とリフレッシュレート

CanvasSize ​

継承元: IGraphics

csharp
int2 CanvasSize { get; }

キャンバス解像度

備考

ChangeCanvasSize を呼び出すことで変更できます

CanvasWidth ​

継承元: IGraphicsEx

csharp
int CanvasWidth { get; }

キャンバスの横幅

CircleResolution ​

継承元: IGraphics

csharp
int CircleResolution { get; set; }

円の解像度

Color ​

継承元: IGraphics

csharp
Color Color { get; set; }

描画色

ColorAqua ​

継承元: IGraphicsEx

csharp
Color ColorAqua { get; }

水色

ColorBlack ​

継承元: IGraphicsEx

csharp
Color ColorBlack { get; }

黒色

ColorBlue ​

継承元: IGraphicsEx

csharp
Color ColorBlue { get; }

青色

ColorCyan ​

継承元: IGraphicsEx

csharp
Color ColorCyan { get; }

シアン

ColorGray ​

継承元: IGraphicsEx

csharp
Color ColorGray { get; }

灰色

ColorGreen ​

継承元: IGraphicsEx

csharp
Color ColorGreen { get; }

緑色

ColorPurple ​

継承元: IGraphicsEx

csharp
Color ColorPurple { get; }

紫色

ColorRed ​

継承元: IGraphicsEx

csharp
Color ColorRed { get; }

赤色

ColorWhite ​

継承元: IGraphicsEx

csharp
Color ColorWhite { get; }

白色

ColorYellow ​

継承元: IGraphicsEx

csharp
Color ColorYellow { get; }

黄色

CoordinateScope ​

継承元: IGraphics

csharp
CoordinateScope CoordinateScope { get; }

PushCoordinate と PopCoordinate が自動的に呼び出されるスコープ

CornerRadius ​

継承元: IGraphics

csharp
float CornerRadius { get; set; }

角丸の半径

CurrentCoordinate ​

継承元: IGraphics

csharp
float2x3 CurrentCoordinate { get; set; }

現在の座標系（変換行列）

CurrentFrame ​

継承元: ITime

csharp
int CurrentFrame { get; }

アプリ起動からの累計フレーム数

CurrentStyle ​

継承元: IGraphics

csharp
GcStyle CurrentStyle { get; set; }

現在のスタイル

CurrentTime ​

継承元: ITime

csharp
System.DateTimeOffset CurrentTime { get; }

現在フレームの日時

CurrentTimeDay ​

継承元: ITimeEx

csharp
int CurrentTimeDay { get; }

現在フレームの日付（1～31）

CurrentTimeDayOfWeek ​

継承元: ITimeEx

csharp
System.DayOfWeek CurrentTimeDayOfWeek { get; }

現在フレームの曜日（0～6）

CurrentTimeHour ​

継承元: ITimeEx

csharp
int CurrentTimeHour { get; }

現在フレームの時刻の時間部分（0～23）

CurrentTimeMillisecond ​

継承元: ITimeEx

csharp
int CurrentTimeMillisecond { get; }

現在フレームの時刻のミリ秒部分（0～999）

CurrentTimeMinute ​

継承元: ITimeEx

csharp
int CurrentTimeMinute { get; }

現在フレームの時刻の分部分（0～59）

CurrentTimeMonth ​

継承元: ITimeEx

csharp
int CurrentTimeMonth { get; }

現在フレームの日付の月部分（1～12）

CurrentTimeSecond ​

継承元: ITimeEx

csharp
int CurrentTimeSecond { get; }

現在フレームの時刻の秒部分（0～59）

CurrentTimestamp ​

継承元: ITime

csharp
long CurrentTimestamp { get; }

現在フレームのUnixタイムスタンプ

CurrentTimeYear ​

継承元: ITimeEx

csharp
int CurrentTimeYear { get; }

現在フレームの日付の西暦部分

DeviceScreenHeight ​

継承元: IGraphicsEx

csharp
int DeviceScreenHeight { get; }

端末スクリーンの縦幅

DeviceScreenSize ​

継承元: IGraphics

csharp
int2 DeviceScreenSize { get; }

端末スクリーン解像度

DeviceScreenWidth ​

継承元: IGraphicsEx

csharp
int DeviceScreenWidth { get; }

端末スクリーンの横幅

DidUpdateAccelerationThisFrame ​

継承元: IInputAcceleration

csharp
bool DidUpdateAccelerationThisFrame { get; }

前回のフレーム処理以降に 加速度イベントの更新があったかどうか

DidUpdateGeolocationThisFrame ​

継承元: IInputGeolocation

csharp
bool DidUpdateGeolocationThisFrame { get; }

前回のフレーム処理以降に 位置情報イベントの更新があったかどうか

Font ​

継承元: IGraphics

csharp
GcFont Font { get; set; }

フォント種別

FontSize ​

継承元: IGraphics

csharp
int FontSize { get; set; }

フォントサイズ

GeolocationStatus ​

継承元: IInputGeolocation

csharp
LocationServiceStatus GeolocationStatus { get; }

位置情報サービスの状態

HasUserAuthorizedPermissionCamera ​

継承元: IInputCamera

csharp
bool HasUserAuthorizedPermissionCamera { get; }

カメラデバイスへのアクセス権限を取得済みかどうか

HasUserAuthorizedPermissionGeolocation ​

継承元: IInputGeolocation

csharp
bool HasUserAuthorizedPermissionGeolocation { get; }

位置情報へのアクセス権限を取得済みかどうか

IsAccelerometerEnabled ​

継承元: IInputAcceleration

csharp
bool IsAccelerometerEnabled { get; set; }

加速度計が現在有効かどうか

IsAccelerometerSupported ​

継承元: IInputAcceleration

csharp
bool IsAccelerometerSupported { get; }

端末が加速度計を搭載しているかどうか

IsAnyKey ​

継承元: IInputKeyEx

csharp
bool IsAnyKey { get; }

なんらかのキーイベントがあるかどうか

IsAnyKeyDown ​

継承元: IInputKeyEx

csharp
bool IsAnyKeyDown { get; }

いずれかのキーが押されたかどうか

IsAnyKeyHold ​

継承元: IInputKeyEx

csharp
bool IsAnyKeyHold { get; }

いずれかのキーが押されているかどうか（押された瞬間を除く）

IsAnyKeyPress ​

継承元: IInputKeyEx

csharp
bool IsAnyKeyPress { get; }

いずれかのキーが押されているかどうか（押された瞬間を含む）

IsAnyKeyUp ​

継承元: IInputKeyEx

csharp
bool IsAnyKeyUp { get; }

いずれかのキーが離されたかどうか

IsGeolocationRunning ​

継承元: IInputGeolocationEx

csharp
bool IsGeolocationRunning { get; }

位置情報サービスが起動しているかどうか（起動中を含む）

IsScreenKeyboardSupported ​

継承元: IInputKey

csharp
bool IsScreenKeyboardSupported { get; }

スクリーンキーボードがサポートされているかどうか

IsScreenKeyboardVisible ​

継承元: IInputKey

csharp
bool IsScreenKeyboardVisible { get; }

スクリーンキーボードが表示されているかどうか

IsTouchPressureSupported ​

継承元: IInputPointer

csharp
bool IsTouchPressureSupported { get; }

実行端末でタッチ圧力がサポートされているかどうか

IsTouchSupported ​

継承元: IInputPointer

csharp
bool IsTouchSupported { get; }

実行端末でタッチ操作がサポートされているかどうか

備考

Windowsエディタ環境では、タッチ対応デバイスであっても常に偽を返します

KeyDownCount ​

継承元: IInputKey

csharp
int KeyDownCount { get; }

前回のフレーム処理以降に 押されたキーの数

KeyEscape ​

継承元: IInputKeyEx

csharp
Key KeyEscape { get; }

戻るボタン（Androidのみ）

KeyHoldCount ​

継承元: IInputKey

csharp
int KeyHoldCount { get; }

前回のフレームに引き続き 押されているキーの数（押された瞬間を除く）

KeyPressCount ​

継承元: IInputKeyEx

csharp
int KeyPressCount { get; }

前回のフレームに引き続き 押されているキーの数（押された瞬間を含む）

KeyUpCount ​

継承元: IInputKey

csharp
int KeyUpCount { get; }

前回のフレーム処理以降に 離されたキーの数

LastAccelerationEvent ​

継承元: IInputAcceleration

csharp
GcAccelerationEvent LastAccelerationEvent { get; }

最後に検出した加速度イベント

LastGeolocationEvent ​

継承元: IInputGeolocation

csharp
GcGeolocationEvent LastGeolocationEvent { get; }

最後に取得した位置情報イベント

LastPointerEvent ​

継承元: IInputPointer

csharp
GcPointerEvent LastPointerEvent { get; }

最後に検出したポインターイベント。過去のフレームも含める

LastPointerFrame ​

継承元: IInputPointerEx

csharp
int LastPointerFrame { get; }

最後に検出したポインターイベントの 検出フレーム番号

LastPointerPoint ​

継承元: IInputPointerEx

csharp
float2 LastPointerPoint { get; }

最後に検出したポインターイベントの位置

LastPointerTime ​

継承元: IInputPointerEx

csharp
float LastPointerTime { get; }

最後に検出したポインターイベントの 検出時間（起動からの経過秒数）

LastPointerX ​

継承元: IInputPointerEx

csharp
float LastPointerX { get; }

最後に検出したポインターイベントの X座標

LastPointerY ​

継承元: IInputPointerEx

csharp
float LastPointerY { get; }

最後に検出したポインターイベントの Y座標

LineCap ​

継承元: IGraphics

csharp
GcLineCap LineCap { get; set; }

描線の端点の形状

LineWidth ​

継承元: IGraphics

csharp
float LineWidth { get; set; }

描線の太さ

NowTime ​

継承元: ITime

csharp
System.DateTimeOffset NowTime { get; }

現在（関数呼び出し時点）の日時

PointerBeginCount ​

継承元: IInputPointer

csharp
int PointerBeginCount { get; }

前回のフレーム処理以降に検出した ポインター開始イベントの数

PointerCount ​

継承元: IInputPointer

csharp
int PointerCount { get; }

前回のフレーム処理以降に検出した ポインターイベントの数

PointerEndCount ​

継承元: IInputPointer

csharp
int PointerEndCount { get; }

前回のフレーム処理以降に検出した ポインター終了イベントの数

PointerTapCount ​

継承元: IInputPointer

csharp
int PointerTapCount { get; }

前回のフレーム処理以降に検出した タップポイントの数

RectAnchor ​

継承元: IGraphics

csharp
GcAnchor RectAnchor { get; set; }

矩形のアンカー位置

StringAnchor ​

継承元: IGraphics

csharp
GcAnchor StringAnchor { get; set; }

文字列のアンカー位置

StyleScope ​

継承元: IGraphics

csharp
StyleScope StyleScope { get; }

PushStyle と PopStyle が自動的に呼び出されるスコープ

TapSettings ​

継承元: IInputPointer

csharp
GcTapSettings TapSettings { get; set; }

タップ感度の設定

TargetFrameInterval ​

継承元: ITime

csharp
double TargetFrameInterval { get; }

フレーム更新間隔の目標値（秒）

TargetFrameRate ​

継承元: ITime

csharp
int TargetFrameRate { get; }

フレームレート（1秒あたりのフレーム数）の目標値

TimeSincePrevFrame ​

継承元: ITime

csharp
float TimeSincePrevFrame { get; }

ひとつ前のフレームからの経過時間（秒）

TimeSinceStartup ​

継承元: ITime

csharp
float TimeSinceStartup { get; }

現在フレームのアプリ起動からの経過時間（秒）

VSyncEnabled ​

継承元: ITime

csharp
bool VSyncEnabled { get; }

垂直同期の有無

備考

この設定は、SetFrameInterval や SetFrameRate の第二引数から変更できます。

メソッド ​

Abs(float) ​

継承元: IMath

csharp
float Abs(in float value)

絶対値を計算します

パラメーター

  • value — 入力値

戻り値

絶対値

Abs(int) ​

継承元: IMath

csharp
int Abs(in int value)

絶対値を計算します

パラメーター

  • value — 入力値

戻り値

絶対値

AddActor(GcActor) ​

継承元: ISceneManagement

csharp
void AddActor(in GcActor actor)

指定したアクターをシーンに登録します

パラメーター

  • actor — 登録するアクター

AlmostSame(float, float) ​

継承元: IMath

csharp
bool AlmostSame(in float a, in float b)

計算誤差を考慮して同値かどうか判定します

戻り値

同値かどうか

AlmostZero(float) ​

継承元: IMath

csharp
bool AlmostZero(in float value)

計算誤差を考慮してゼロかどうか判定します

パラメーター

  • value — 入力値

戻り値

ゼロかどうか

Atan2(float, float) ​

継承元: IMathEx

csharp
float Atan2(in float x, in float y)

ベクトルとX+軸平面のなす角度を計算します

パラメーター

  • x — ベクトルのX軸の大きさ
  • y — ベクトルのY軸の大きさ

戻り値

角度（度数法）

Atan2(float2) ​

継承元: IMath

csharp
float Atan2(in float2 v)

ベクトルとX+軸平面のなす角度を計算します

パラメーター

  • v — ベクトル

戻り値

角度（度数法）

CalcStringHeight(string) ​

継承元: IGraphics

csharp
float CalcStringHeight(in string str)

文字列の縦幅を計算します

パラメーター

  • str — 文字列

戻り値

縦幅

CalcStringSize(string) ​

継承元: IGraphics

csharp
float2 CalcStringSize(in string str)

文字列のサイズを計算します

パラメーター

  • str — 文字列

戻り値

サイズ

CalcStringWidth(string) ​

継承元: IGraphics

csharp
float CalcStringWidth(in string str)

文字列の横幅を計算します

パラメーター

  • str — 文字列

戻り値

横幅

CanvasToScreenPoint(float2, float2) ​

継承元: IGraphics

csharp
void CanvasToScreenPoint(in float2 canvas, out float2 screen)

キャンバス座標を端末スクリーン座標に変換します

パラメーター

  • canvas — 変換元 キャンバス座標
  • screen — 変換後 端末スクリーン座標

CanvasToScreenPoint(float2, int2) ​

継承元: IGraphics

csharp
void CanvasToScreenPoint(in float2 canvas, out int2 screen)

キャンバス座標を端末スクリーン座標に変換します

パラメーター

  • canvas — 変換元 キャンバス座標
  • screen — 変換後 端末スクリーン座標

ChangeBorderColor(Color) ​

継承元: IGraphics

csharp
void ChangeBorderColor(in Color color)

キャンバス外の帯の色を変更します

備考

既存キャンバスの描画内容は全て破棄されます

パラメーター

  • color — 新しい帯の色

ChangeBorderColor(float, float, float) ​

継承元: IGraphicsEx

csharp
void ChangeBorderColor(in float r, in float g, in float b)

帯の色を変更します

パラメーター

  • r — 帯の色の赤成分
  • g — 帯の色の緑成分
  • b — 帯の色の青成分

ChangeCanvasSize(int, int) ​

継承元: IGraphicsEx

csharp
void ChangeCanvasSize(in int width, in int height)

キャンバス解像度を指定します

備考

  • 初期値は 720x1280 です
  • ディスプレイ解像度と縦横比が異なる場合は、上下もしくは左右に帯がつきます

パラメーター

  • width — 横幅
  • height — 縦幅

ChangeCanvasSize(int2) ​

継承元: IGraphics

csharp
void ChangeCanvasSize(in int2 size)

キャンバス解像度を変更します

備考

  • 初期値は 720x1280 です
  • ディスプレイ解像度と縦横比が異なる場合は、上下もしくは左右に帯がつきます
  • 既存キャンバスの描画内容は全て破棄されます

パラメーター

  • size — 新しいキャンバス解像度

ChangeScene<T>(object?) ​

継承元: ISceneManagementEx

csharp
void ChangeScene<T>(object? state = null) where T : GcScene

シーンを切り替えます

備考

  • これまで有効だったシーンは、現在のフレームの最後に終了処理が実行されます
  • これから有効になるシーンは、次のフレームの最初に開始処理が実行されます

型パラメーター

  • T — 開始するシーンの型

パラメーター

  • state — シーンの開始処理 (IScene.EnterScene) に引数として渡す任意の値

Clamp(float, float, float) ​

継承元: IMath

csharp
float Clamp(in float value, in float min, in float max)

値を丸めます

パラメーター

  • value — 入力値
  • min — 最小値
  • max — 最大値

ClearCoordinate() ​

継承元: IGraphics

csharp
void ClearCoordinate()

CurrentCoordinate をリセットします

ClearDownloadCache(string) ​

継承元: INetwork

csharp
void ClearDownloadCache(in string url)

指定されたオンラインリソースのダウンロードキャッシュを削除します

パラメーター

  • url — リソースURL

ClearDownloadCacheAll() ​

継承元: INetwork

csharp
void ClearDownloadCacheAll()

全てのオンラインリソースのダウンロードキャッシュを削除します

ClearScreen() ​

継承元: IGraphics

csharp
void ClearScreen()

キャンバスを BackgroundColor で塗りつぶします

ClearSound() ​

継承元: ISound

csharp
void ClearSound()

すべてのサウンド再生を停止し、トラック音量を初期値に戻します

ClearStyle() ​

継承元: IGraphics

csharp
void ClearStyle()

CurrentStyle をリセットします

Cos(float) ​

継承元: IMath

csharp
float Cos(in float degree)

コサインを計算します

パラメーター

  • degree — 角度（度数法）

戻り値

コサイン

CreateActor<T>() ​

継承元: ISceneManagement

csharp
T CreateActor<T>() where T : GcActor, new()

指定したアクターを生成し、シーンに登録します

型パラメーター

  • T — 生成・登録するアクターの型

戻り値

登録したアクター

Cross(float2, float2) ​

継承元: IMath

csharp
float Cross(in float2 a, in float2 b)

ベクトルの外積を計算します

戻り値

外積

CrossTest(GcLine, GcLine, float2) ​

継承元: IPhysics

csharp
bool CrossTest(in GcLine a, in GcLine b, out float2 intersection)

GcLine と GcLine の交差判定

CrossTest(GcLine, GcLine) ​

継承元: IPhysics

csharp
bool CrossTest(in GcLine a, in GcLine b)

GcLine と GcLine の交差判定

DidUpdateCameraImageThisFrame(GcCameraDevice) ​

継承元: IInputCamera

csharp
bool DidUpdateCameraImageThisFrame(in GcCameraDevice camera)

前回のフレーム処理以降に 指定されたカメラ（外部入力映像）テクスチャーに更新があったかどうか

パラメーター

  • camera — カメラ（外部入力映像）

戻り値

テクスチャーに更新があったかどうか

Dot(float2, float2) ​

継承元: IMath

csharp
float Dot(in float2 a, in float2 b)

ベクトルの内積を計算します

戻り値

内積

DrawCameraImage(GcCameraDevice, bool) ​

継承元: IInputCameraEx

csharp
void DrawCameraImage(in GcCameraDevice camera, bool autoPlay = true)

カメラ（外部入力映像）を描画します

パラメーター

  • camera — カメラ（外部入力映像）
  • autoPlay — カメラ（外部入力映像）が停止していた場合、内部でPlayCameraImageを呼び出すかどうか

DrawCameraImage(GcCameraDevice, float, float, float, bool) ​

継承元: IInputCameraEx

csharp
void DrawCameraImage(in GcCameraDevice camera, in float x, in float y, float degree = 0f, bool autoPlay = true)

カメラ（外部入力映像）を描画します

パラメーター

  • camera — カメラ（外部入力映像）
  • x — X座標
  • y — Y座標
  • degree — 回転（度数法）
  • autoPlay — カメラ（外部入力映像）が停止していた場合、内部でPlayCameraImageを呼び出すかどうか

DrawCameraImage(GcCameraDevice, float, float, float, float, float, bool) ​

継承元: IInputCameraEx

csharp
void DrawCameraImage(in GcCameraDevice camera, in float x, in float y, in float width, in float height, float degree = 0f, bool autoPlay = true)

カメラ（外部入力映像）を拡縮して描画します

パラメーター

  • camera — カメラ（外部入力映像）
  • x — X座標
  • y — Y座標
  • width — 横幅。映像の横幅がこれになるように拡縮される
  • height — 縦幅。映像の縦幅がこれになるように拡縮される
  • degree — 回転（度数法）
  • autoPlay — カメラ（外部入力映像）が停止していた場合、内部でPlayCameraImageを呼び出すかどうか

DrawCameraImage(GcCameraDevice, float2, float, bool) ​

継承元: IInputCameraEx

csharp
void DrawCameraImage(in GcCameraDevice camera, in float2 position, float degree = 0f, bool autoPlay = true)

カメラ（外部入力映像）を描画します

パラメーター

  • camera — カメラ（外部入力映像）
  • position — 位置
  • degree — 回転（度数法）
  • autoPlay — カメラ（外部入力映像）が停止していた場合、内部でPlayCameraImageを呼び出すかどうか

DrawCameraImage(GcCameraDevice, GcRect, bool) ​

継承元: IInputCameraEx

csharp
void DrawCameraImage(in GcCameraDevice camera, in GcRect rect, bool autoPlay = true)

カメラ（外部入力映像）を拡縮して描画します

パラメーター

  • camera — カメラ（外部入力映像）
  • rect — 映像をフィッティングする矩形領域
  • autoPlay — カメラ（外部入力映像）が停止していた場合、内部でPlayCameraImageを呼び出すかどうか

DrawCircle() ​

継承元: IGraphics

csharp
void DrawCircle()

中抜きの円を描画します

DrawCircle(float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawCircle(in float x, in float y, in float radius)

円を線で描画します

パラメーター

  • x — 中心のX座標
  • y — 中心のY座標
  • radius — 半径

DrawCircle(float2, float) ​

継承元: IGraphicsEx

csharp
void DrawCircle(in float2 position, in float radius)

円を線で描画します

パラメーター

  • position — 中心の座標
  • radius — 半径

DrawCircle(GcCircle) ​

継承元: IGraphics

csharp
void DrawCircle(in GcCircle circle)

中抜きの円を描画します

パラメーター

  • circle — 円

DrawImage(GcImage, float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawImage(in GcImage image, in float x, in float y, in float width, in float height, float degree = 0f)

画像を拡縮して描画します

パラメーター

  • image — 描画する画像
  • x — X座標
  • y — Y座標
  • width — 横幅。画像の横幅がこれになるように拡縮される
  • height — 縦幅。画像の縦幅がこれになるように拡縮される
  • degree — 回転（度数法）

DrawImage(GcImage, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawImage(in GcImage image, in float x, in float y, float degree = 0f)

画像を描画します

パラメーター

  • image — 描画する画像
  • x — X座標
  • y — Y座標
  • degree — 回転（度数法）

DrawImage(GcImage, float2, float) ​

継承元: IGraphics

csharp
void DrawImage(in GcImage image, in float2 position, float degree = 0f)

画像を描画します

パラメーター

  • image — 描画する画像
  • position — 位置
  • degree — 回転（度数法）

DrawImage(GcImage, GcRect) ​

継承元: IGraphics

csharp
void DrawImage(in GcImage image, in GcRect rect)

画像を拡縮して描画します

パラメーター

  • image — 描画する画像
  • rect — 画像をフィッティングする矩形領域

DrawImage(GcImage) ​

継承元: IGraphics

csharp
void DrawImage(in GcImage image)

画像を描画します

パラメーター

  • image — 描画する画像

DrawLine() ​

継承元: IGraphics

csharp
void DrawLine()

線を描画します

DrawLine(float, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawLine(in float x0, in float y0, in float x1, in float y1)

線を描画します

パラメーター

  • x0 — 始点のX座標
  • y0 — 始点のY座標
  • x1 — 終点のX座標
  • y1 — 終点のY座標

DrawLine(float2, float2) ​

継承元: IGraphicsEx

csharp
void DrawLine(in float2 begin, in float2 end)

線を描画します

パラメーター

  • begin — 始点
  • end — 終点

DrawLine(GcLine) ​

継承元: IGraphics

csharp
void DrawLine(in GcLine line)

線を描画します

パラメーター

  • line — 線

DrawOnlineImage(string, float, float, float, float, float) ​

継承元: INetworkEx

csharp
GcAvailability DrawOnlineImage(in string url, in float x, in float y, in float width, in float height, float degree = 0f)

オンライン画像リソースを拡縮して描画します

パラメーター

  • url — リソースURL
  • x — X座標
  • y — Y座標
  • width — 横幅。画像の横幅がこれになるように拡縮される
  • height — 縦幅。画像の縦幅がこれになるように拡縮される
  • degree — 回転（度数法）

DrawOnlineImage(string, float, float, float) ​

継承元: INetworkEx

csharp
GcAvailability DrawOnlineImage(in string url, in float x, in float y, float degree = 0f)

オンライン画像リソースを描画します

パラメーター

  • url — リソースURL
  • x — X座標
  • y — Y座標
  • degree — 回転（度数法）

戻り値

オンラインリソースの可用性

DrawOnlineImage(string, float2, float) ​

継承元: INetworkEx

csharp
GcAvailability DrawOnlineImage(in string url, in float2 position, float degree = 0f)

オンライン画像リソースを描画します

パラメーター

  • url — リソースURL
  • position — 位置
  • degree — 回転（度数法）

戻り値

オンラインリソースの可用性

DrawOnlineImage(string, GcRect) ​

継承元: INetworkEx

csharp
GcAvailability DrawOnlineImage(in string url, in GcRect rect)

オンライン画像リソースを拡縮して描画します

パラメーター

  • url — リソースURL
  • rect — 画像をフィッティングする矩形領域

DrawOnlineImage(string) ​

継承元: INetworkEx

csharp
GcAvailability DrawOnlineImage(in string url)

オンライン画像リソースを描画します

パラメーター

  • url — リソースURL

戻り値

オンラインリソースの可用性

DrawRect() ​

継承元: IGraphics

csharp
void DrawRect()

矩形を線で描画します

DrawRect(float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawRect(in float x, in float y, in float width, in float height, float degree = 0f)

矩形を線で描画します

パラメーター

  • x — X座標
  • y — Y座標
  • width — 横幅
  • height — 縦幅
  • degree — 回転（度数法）

DrawRect(float2, float2, float) ​

継承元: IGraphicsEx

csharp
void DrawRect(in float2 position, in float2 size, float degree = 0f)

矩形を線で描画します

パラメーター

  • position — 位置
  • size — 大きさ
  • degree — 回転（度数法）

DrawRect(GcRect) ​

継承元: IGraphics

csharp
void DrawRect(in GcRect rect)

矩形を線で描画します

パラメーター

  • rect — 矩形

DrawRoundedRect() ​

継承元: IGraphics

csharp
void DrawRoundedRect()

角丸矩形を線で描画します

DrawRoundedRect(float, float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawRoundedRect(in float x, in float y, in float width, in float height, float cornerRadius, float degree = 0f)

角丸矩形を線で描画します

パラメーター

  • x — X座標
  • y — Y座標
  • width — 横幅
  • height — 縦幅
  • cornerRadius — 角丸の半径
  • degree — 回転（度数法）

DrawRoundedRect(float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawRoundedRect(in float x, in float y, in float width, in float height, float degree = 0f)

角丸矩形を線で描画します

パラメーター

  • x — X座標
  • y — Y座標
  • width — 横幅
  • height — 縦幅
  • degree — 回転（度数法）

DrawRoundedRect(float2, float2, float, float) ​

継承元: IGraphicsEx

csharp
void DrawRoundedRect(in float2 position, in float2 size, float cornerRadius, float degree = 0f)

角丸矩形を線で描画します

パラメーター

  • position — 位置
  • size — 大きさ
  • cornerRadius — 角丸の半径
  • degree — 回転（度数法）

DrawRoundedRect(float2, float2, float) ​

継承元: IGraphicsEx

csharp
void DrawRoundedRect(in float2 position, in float2 size, float degree = 0f)

角丸矩形を線で描画します

パラメーター

  • position — 位置
  • size — 大きさ
  • degree — 回転（度数法）

DrawRoundedRect(GcRect, float) ​

継承元: IGraphics

csharp
void DrawRoundedRect(in GcRect rect, float cornerRadius)

角丸矩形を線で描画します

パラメーター

  • rect — 二等辺三角形が収まる矩形
  • cornerRadius — 角丸の半径

DrawRoundedRect(GcRect) ​

継承元: IGraphics

csharp
void DrawRoundedRect(in GcRect rect)

角丸矩形を線で描画します

パラメーター

  • rect — 二等辺三角形が収まる矩形

DrawString(string, float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawString(in string str, in float x, in float y, in float width, in float height, float degree = 0f)

文字列を拡縮して描画します

パラメーター

  • str — 描画する文字列
  • x — X座標
  • y — Y座標
  • width — 横幅。文字列の横幅がこれになるように拡縮される
  • height — 縦幅。文字列の縦幅がこれになるように拡縮される
  • degree — 回転（度数法）

DrawString(string, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawString(in string str, in float x, in float y, float degree = 0f)

文字列を描画します

パラメーター

  • str — 描画する文字列
  • x — X座標
  • y — Y座標
  • degree — 回転（度数法）

DrawString(string, float2, float) ​

継承元: IGraphics

csharp
void DrawString(in string str, in float2 position, float degree = 0f)

文字列を描画します

パラメーター

  • str — 描画する文字列
  • position — 位置
  • degree — 回転（度数法）

DrawString(string, GcRect) ​

継承元: IGraphics

csharp
void DrawString(in string str, in GcRect rect)

文字列を拡縮して描画します

パラメーター

  • str — 描画する文字列
  • rect — 文字列をフィッティングする矩形領域

DrawString(string) ​

継承元: IGraphics

csharp
void DrawString(in string str)

文字列を描画します

パラメーター

  • str — 描画する文字列

DrawTexture(Texture, float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void DrawTexture(in Texture texture, in float x, in float y, in float width, in float height, float degree = 0f)

テクスチャーを拡縮して描画します

パラメーター

  • texture — 描画するテクスチャー
  • x — X座標
  • y — Y座標
  • width — 横幅。画像の横幅がこれになるように拡縮される
  • height — 縦幅。画像の縦幅がこれになるように拡縮される
  • degree — 回転（度数法）

DrawTexture(Texture, float2, float) ​

継承元: IGraphics

csharp
void DrawTexture(in Texture texture, in float2 position, float degree = 0f)

テクスチャーを描画します

パラメーター

  • texture — 描画するテクスチャー
  • position — 位置
  • degree — 回転（度数法）

DrawTexture(Texture, float2x3) ​

継承元: IGraphics

csharp
void DrawTexture(in Texture texture, in float2x3 matrix)

テクスチャーを変形して描画します

パラメーター

  • texture — 描画するテクスチャー
  • matrix — アフィン変換行列

DrawTexture(Texture, GcRect) ​

継承元: IGraphics

csharp
void DrawTexture(in Texture texture, in GcRect rect)

テクスチャーを拡縮して描画します

パラメーター

  • texture — 描画するテクスチャー
  • rect — テクスチャーをフィッティングする矩形領域

DrawTexture(Texture) ​

継承元: IGraphics

csharp
void DrawTexture(in Texture texture)

テクスチャーを描画します

パラメーター

  • texture — 描画するテクスチャー

EraseSavedDataAll() ​

継承元: IStorage

csharp
void EraseSavedDataAll()

ローカルストレージに保存された全ての値を削除します

FillCircle() ​

継承元: IGraphics

csharp
void FillCircle()

円を塗りで描画します

FillCircle(float, float, float) ​

継承元: IGraphicsEx

csharp
void FillCircle(in float x, in float y, in float radius)

円を塗りで描画します

パラメーター

  • x — 中心のX座標
  • y — 中心のY座標
  • radius — 半径

FillCircle(float2, float) ​

継承元: IGraphicsEx

csharp
void FillCircle(in float2 position, in float radius)

円を塗りで描画します

パラメーター

  • position — 中心の座標
  • radius — 半径

FillCircle(GcCircle) ​

継承元: IGraphics

csharp
void FillCircle(in GcCircle circle)

円を塗りで描画します

パラメーター

  • circle — 円

FillRect() ​

継承元: IGraphics

csharp
void FillRect()

矩形を塗りで描画します

FillRect(float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void FillRect(in float x, in float y, in float width, in float height, float degree = 0f)

矩形を塗りで描画します

パラメーター

  • x — X座標
  • y — Y座標
  • width — 横幅
  • height — 縦幅
  • degree — 回転（度数法）

FillRect(float2, float2, float) ​

継承元: IGraphicsEx

csharp
void FillRect(in float2 position, in float2 size, float degree = 0f)

矩形を塗りで描画します

パラメーター

  • position — 位置
  • size — 大きさ
  • degree — 回転（度数法）

FillRect(GcRect) ​

継承元: IGraphics

csharp
void FillRect(in GcRect rect)

矩形を塗りで描画します

パラメーター

  • rect — 矩形

FillRoundedRect() ​

継承元: IGraphics

csharp
void FillRoundedRect()

角丸矩形を塗りで描画します

FillRoundedRect(float, float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void FillRoundedRect(in float x, in float y, in float width, in float height, float cornerRadius, float degree = 0f)

角丸矩形を塗りで描画します

パラメーター

  • x — X座標
  • y — Y座標
  • width — 横幅
  • height — 縦幅
  • cornerRadius — 角丸の半径
  • degree — 回転（度数法）

FillRoundedRect(float, float, float, float, float) ​

継承元: IGraphicsEx

csharp
void FillRoundedRect(in float x, in float y, in float width, in float height, float degree = 0f)

角丸矩形を塗りで描画します

パラメーター

  • x — X座標
  • y — Y座標
  • width — 横幅
  • height — 縦幅
  • degree — 回転（度数法）

FillRoundedRect(float2, float2, float, float) ​

継承元: IGraphicsEx

csharp
void FillRoundedRect(in float2 position, in float2 size, float cornerRadius, float degree = 0f)

角丸矩形を塗りで描画します

パラメーター

  • position — 位置
  • size — 大きさ
  • cornerRadius — 角丸の半径
  • degree — 回転（度数法）

FillRoundedRect(float2, float2, float) ​

継承元: IGraphicsEx

csharp
void FillRoundedRect(in float2 position, in float2 size, float degree = 0f)

角丸矩形を塗りで描画します

パラメーター

  • position — 位置
  • size — 大きさ
  • degree — 回転（度数法）

FillRoundedRect(GcRect, float) ​

継承元: IGraphics

csharp
void FillRoundedRect(in GcRect rect, float cornerRadius)

角丸矩形を塗りで描画します

パラメーター

  • rect — 二等辺三角形が収まる矩形
  • cornerRadius — 角丸の半径

FillRoundedRect(GcRect) ​

継承元: IGraphics

csharp
void FillRoundedRect(in GcRect rect)

角丸矩形を塗りで描画します

パラメーター

  • rect — 二等辺三角形が収まる矩形

FocusCameraImage(GcCameraDevice, float2?) ​

継承元: IInputCamera

csharp
void FocusCameraImage(in GcCameraDevice camera, in float2? uv)

カメラ（外部入力映像）の任意の点に焦点をあわせるように要求します

備考

  • このAPIは、対応するカメラデバイスに対して、実機上での実行したときのみ動作します
  • uv引数は、キャンバス座標系ではなく、左下を原点とする 0.0～1.0 のUV座標系を指定します
  • 焦点あわせを解除するには、uv引数に null を渡します

パラメーター

  • camera — カメラ（外部入力映像）
  • uv — 焦点をあわせる位置（左下を原点とする 0.0～1.0 のUV座標系）

GetActor() ​

継承元: ISceneManagementEx

csharp
GcActor? GetActor()

シーンに登録されているアクターのうち、1つだけ取得します

戻り値

取得できたアクター

GetActor<T>() ​

継承元: ISceneManagementEx

csharp
T? GetActor<T>() where T : GcActor

シーンに登録されているアクターのうち、指定した型のものを1つだけ取得します

型パラメーター

  • T — 取得するアクターの型

戻り値

取得できたアクター

GetActorCount() ​

継承元: ISceneManagement

csharp
int GetActorCount()

シーンに登録されているアクターの総数を取得します

戻り値

アクターの数

GetActorCount<T>() ​

継承元: ISceneManagement

csharp
int GetActorCount<T>() where T : GcActor

シーンに登録されているアクターのうち、指定した型のものが幾つあるか取得します

型パラメーター

  • T — 取得するアクターの型

戻り値

アクターの数

GetActorList<T>() ​

継承元: ISceneManagementEx

csharp
ReadOnlyActorList<T> GetActorList<T>() where T : GcActor

シーンに登録されているアクターのうち、指定した型のものを取得します

型パラメーター

  • T — 取得するアクターの型

戻り値

取得したアクターのリスト

GetImageHeight(GcImage) ​

継承元: IGraphicsEx

csharp
int GetImageHeight(in GcImage image)

画像の縦幅を取得します

パラメーター

  • image — 画像

戻り値

縦幅

GetImageSize(GcImage) ​

継承元: IGraphicsEx

csharp
int2 GetImageSize(in GcImage image)

画像のサイズを取得します

パラメーター

  • image — 画像

戻り値

サイズ

GetImageWidth(GcImage) ​

継承元: IGraphicsEx

csharp
int GetImageWidth(in GcImage image)

画像の横幅を取得します

パラメーター

  • image — 画像

戻り値

横幅

GetKeyPressDuration(Key) ​

継承元: IInputKeyEx

csharp
float GetKeyPressDuration(in Key key)

指定されたキーが押されている時間（秒）

パラメーター

  • key — キー

戻り値

時間（秒）

GetKeyPressFrameCount(Key) ​

継承元: IInputKeyEx

csharp
int GetKeyPressFrameCount(in Key key)

指定されたキーが押されているフレーム数

パラメーター

  • key — キー

戻り値

フレーム数

GetOnlineImageHeight(string) ​

継承元: INetworkEx

csharp
int GetOnlineImageHeight(in string url)

オンライン画像リソースの縦幅を取得します

パラメーター

  • url — リソースURL

戻り値

オンライン画像リソースの縦幅。取得できなかった場合は0を返します

GetOnlineImageWidth(string) ​

継承元: INetworkEx

csharp
int GetOnlineImageWidth(in string url)

オンライン画像リソースの横幅を取得します

パラメーター

  • url — リソースURL

戻り値

オンライン画像リソースの横幅。取得できなかった場合は0を返します

GetOrCreateCameraTexture(GcCameraDevice, GcResolution) ​

継承元: IInputCamera

csharp
WebCamTexture? GetOrCreateCameraTexture(in GcCameraDevice camera, in GcResolution request)

指定されたカメラ（外部入力映像）のテクスチャーを生成もしくは取得します

備考

  • 既にテクスチャーが生成済みの場合は、request引数の値は無視されます
  • 生成後に解像度を変更する場合は TryChangeCameraImageResolution 関数を呼び出してください

パラメーター

  • camera — カメラ（外部入力映像）
  • request — テクスチャーが未生成だった場合に、希望する解像度とリフレッシュレート

戻り値

テクスチャー

GetPrimaryCameraResolution(GcCameraDevice) ​

継承元: IInputCameraEx

csharp
GcResolution GetPrimaryCameraResolution(in GcCameraDevice camera)

指定されたカメラ（外部入力映像）の推奨解像度を取得します

備考

  • 推奨解像度を取得できない場合、現在のキャンバス解像度とフレームレートに基づいた適当な値を返します
  • エディタでは常に推奨解像度を取得できません

パラメーター

  • camera — カメラ（外部入力映像）

戻り値

解像度とリフレッシュレート

GetRandomState() ​

継承元: IMath

csharp
uint GetRandomState()

乱数計算の現在の状態（≒シード値）を取得します

戻り値

シード値

GetSoundLevel(GcSoundTrack) ​

継承元: ISound

csharp
float GetSoundLevel(GcSoundTrack track = GcSoundTrack.Master)

トラック音量を取得します

パラメーター

  • track — 対象の音声トラック

戻り値

音量（-96db～20db）

GetSoundVolume(GcSoundTrack) ​

継承元: ISoundEx

csharp
float GetSoundVolume(GcSoundTrack track = GcSoundTrack.Master)

トラック音量を取得します

パラメーター

  • track — 対象の音声トラック

戻り値

音量（0f～1f）

HideScreenKeyboard() ​

継承元: IInputKey

csharp
void HideScreenKeyboard()

スクリーンキーボードを閉じます

HitTest(GcAABB, float2) ​

継承元: IPhysics

csharp
bool HitTest(in GcAABB aabb, in float2 point)

GcAABB と 点の接触判定

HitTest(GcAABB, GcAABB) ​

継承元: IPhysics

csharp
bool HitTest(in GcAABB a, in GcAABB b)

GcAABB と GcAABB の接触判定

HitTest(GcCircle, float2) ​

継承元: IPhysics

csharp
bool HitTest(in GcCircle circle, in float2 point)

GcCircle と 点の接触判定

HitTest(GcCircle, GcCircle) ​

継承元: IPhysics

csharp
bool HitTest(in GcCircle circle1, in GcCircle circle2)

GcCircle と GcCircle の接触判定

IsFlippedCameraImage(GcCameraDevice) ​

継承元: IInputCamera

csharp
bool IsFlippedCameraImage(in GcCameraDevice camera)

指定されたカメラ（外部入力映像）は上下が反転しているかどうか

パラメーター

  • camera — カメラ（外部入力映像）

戻り値

上下が反転しているかどうか

IsKeyDown(Key) ​

継承元: IInputKey

csharp
bool IsKeyDown(in Key key)

指定されたキーが押されたかどうか

パラメーター

  • key — キー

戻り値

押されたかどうか

IsKeyHold(Key, GcKeyTrace) ​

継承元: IInputKeyEx

csharp
bool IsKeyHold(in Key key, out GcKeyTrace trace)

指定されたキーが押されているかどうか（押された瞬間を除く）

パラメーター

  • key — キー
  • trace — キーの軌跡

戻り値

押されているかどうか（押された瞬間を除く）

IsKeyHold(Key) ​

継承元: IInputKey

csharp
bool IsKeyHold(in Key key)

指定されたキーが押されているかどうか（押された瞬間を除く）

パラメーター

  • key — キー

戻り値

押されているかどうか（押された瞬間を除く）

IsKeyPress(Key) ​

継承元: IInputKey

csharp
bool IsKeyPress(in Key key)

指定されたキーが押されているかどうか（押された瞬間を含む）

パラメーター

  • key — キー

戻り値

押されているかどうか（押された瞬間を含む）

IsKeyUp(Key, GcKeyTrace) ​

継承元: IInputKeyEx

csharp
bool IsKeyUp(in Key key, out GcKeyTrace trace)

指定されたキーが離されたかどうか

パラメーター

  • key — キー
  • trace — キーの軌跡

戻り値

離されたかどうか

IsKeyUp(Key) ​

継承元: IInputKey

csharp
bool IsKeyUp(in Key key)

指定されたキーが離されたかどうか

パラメーター

  • key — キー

戻り値

離されたかどうか

IsPlayingCameraImage(GcCameraDevice) ​

継承元: IInputCamera

csharp
bool IsPlayingCameraImage(in GcCameraDevice camera)

指定されたカメラ（外部入力映像）の更新が行われているかどうか

パラメーター

  • camera — カメラ（外部入力映像）

戻り値

更新が行われているかどうか

IsPlayingSound(GcSoundTrack) ​

継承元: ISound

csharp
bool IsPlayingSound(GcSoundTrack track = GcSoundTrack.BGM1)

指定された音声トラックが再生中かどうか

パラメーター

  • track — 対象の音声トラック

戻り値

再生中かどうか

IsTapped() ​

継承元: IInputPointerEx

csharp
bool IsTapped()

前回のフレーム処理以降に タップされたかどうか

戻り値

タップされたかどうか

IsTapped(float, float, float, float, float, float) ​

継承元: IInputPointerEx

csharp
bool IsTapped(in float x, in float y, in float width, in float height, out float px, out float py)

前回のフレーム処理以降に 指定した領域がタップされたかどうか

パラメーター

  • x — 領域 左上X座標
  • y — 領域 左上Y座標
  • width — 領域 横幅
  • height — 領域 縦幅
  • px — タップ位置 X座標
  • py — タップ位置 Y座標

戻り値

指定した領域がタップされたかどうか

IsTapped(float, float) ​

継承元: IInputPointerEx

csharp
bool IsTapped(out float x, out float y)

前回のフレーム処理以降に タップされたかどうか

パラメーター

  • x — タップ位置 X座標
  • y — タップ位置 Y座標

戻り値

タップされたかどうか

IsTapped(float2) ​

継承元: IInputPointerEx

csharp
bool IsTapped(out float2 point)

前回のフレーム処理以降に タップされたかどうか

パラメーター

  • point — タップ位置

戻り値

タップされたかどうか

IsTapped(GcAABB, float2) ​

継承元: IInputPointerEx

csharp
bool IsTapped(in GcAABB aabb, out float2 point)

前回のフレーム処理以降に 指定した領域がタップされたかどうか

パラメーター

  • aabb — 領域
  • point — タップ位置

戻り値

指定した領域がタップされたかどうか

IsTouchBegan() ​

継承元: IInputPointerEx

csharp
bool IsTouchBegan()

前回のフレーム処理以降に タッチされ始めたかどうか

戻り値

タッチされ始めたかどうか

IsTouchBegan(float, float, float, float, float, float) ​

継承元: IInputPointerEx

csharp
bool IsTouchBegan(in float x, in float y, in float width, in float height, out float px, out float py)

前回のフレーム処理以降に 指定した領域がタッチされ始めたかどうか

パラメーター

  • x — 領域 左上X座標
  • y — 領域 左上Y座標
  • width — 領域 横幅
  • height — 領域 縦幅
  • px — タッチ位置 X座標
  • py — タッチ位置 Y座標

戻り値

指定した領域がタッチされ始めたかどうか

IsTouchBegan(float, float) ​

継承元: IInputPointerEx

csharp
bool IsTouchBegan(out float x, out float y)

前回のフレーム処理以降に タッチされ始めたかどうか

パラメーター

  • x — タッチ位置 X座標
  • y — タッチ位置 Y座標

戻り値

タッチされ始めたかどうか

IsTouchBegan(float2) ​

継承元: IInputPointerEx

csharp
bool IsTouchBegan(out float2 point)

前回のフレーム処理以降に タッチされ始めたかどうか

パラメーター

  • point — タッチ位置

戻り値

タッチされ始めたかどうか

IsTouchBegan(GcAABB, float2) ​

継承元: IInputPointerEx

csharp
bool IsTouchBegan(in GcAABB aabb, out float2 point)

前回のフレーム処理以降に 指定した領域がタッチされ始めたかどうか

パラメーター

  • aabb — 領域
  • point — タッチ位置

戻り値

指定した領域がタッチされ始めたかどうか

IsTouchBegan(GcPointerEvent) ​

継承元: IInputPointerEx

csharp
bool IsTouchBegan(out GcPointerEvent pointer)

前回のフレーム処理以降に タッチされ始めたかどうか

パラメーター

  • pointer — ポインターイベント

戻り値

タッチされ始めたかどうか

IsTouched() ​

継承元: IInputPointerEx

csharp
bool IsTouched()

前回のフレーム処理以降 タッチされていたか（開始と終了を含む）

戻り値

タッチされていたか（開始と終了を含む）

IsTouched(float, float, float, float, float, float) ​

継承元: IInputPointerEx

csharp
bool IsTouched(in float x, in float y, in float width, in float height, out float px, out float py)

前回のフレーム処理以降 指定した領域がタッチされていたか（開始と終了を含む）

パラメーター

  • x — 領域 左上X座標
  • y — 領域 左上Y座標
  • width — 領域 横幅
  • height — 領域 縦幅
  • px — タッチ位置 X座標
  • py — タッチ位置 Y座標

戻り値

指定した領域がタッチされていたか（開始と終了を含む）

IsTouched(float, float) ​

継承元: IInputPointerEx

csharp
bool IsTouched(out float x, out float y)

前回のフレーム処理以降 タッチされていたか（開始と終了を含む）

パラメーター

  • x — タッチ位置 X座標
  • y — タッチ位置 Y座標

戻り値

タッチされていたか（開始と終了を含む）

IsTouched(float2) ​

継承元: IInputPointerEx

csharp
bool IsTouched(out float2 point)

前回のフレーム処理以降 タッチされていたか（開始と終了を含む）

パラメーター

  • point — タッチ位置

戻り値

タッチされていたか（開始と終了を含む）

IsTouched(GcAABB, float2) ​

継承元: IInputPointerEx

csharp
bool IsTouched(in GcAABB aabb, out float2 point)

前回のフレーム処理以降 指定した領域がタッチされていたか（開始と終了を含む）

パラメーター

  • aabb — 領域
  • point — タッチ位置

戻り値

指定した領域がタッチされていたか（開始と終了を含む）

IsTouched(GcPointerEvent) ​

継承元: IInputPointerEx

csharp
bool IsTouched(out GcPointerEvent e)

前回のフレーム処理以降 タッチされていたか（開始と終了を含む）

パラメーター

  • e — ポインターイベント

戻り値

タッチされていたか（開始と終了を含む）

IsTouched(GcPointerTrace) ​

継承元: IInputPointerEx

csharp
bool IsTouched(out GcPointerTrace trace)

前回のフレーム処理以降 タッチされていたか（開始と終了を含む）

パラメーター

  • trace — タッチの軌跡

戻り値

タッチされていたか（開始と終了を含む）

IsTouchEnded() ​

継承元: IInputPointerEx

csharp
bool IsTouchEnded()

前回のフレーム処理以降 タッチされ終えたかどうか

戻り値

タッチされ終えたかどうか

IsTouchEnded(float, float, float, float, float, float) ​

継承元: IInputPointerEx

csharp
bool IsTouchEnded(in float x, in float y, in float width, in float height, out float px, out float py)

前回のフレーム処理以降 指定した領域がタッチされ終えたかどうか

パラメーター

  • x — 領域 左上X座標
  • y — 領域 左上Y座標
  • width — 領域 横幅
  • height — 領域 縦幅
  • px — タッチ位置 X座標
  • py — タッチ位置 Y座標

戻り値

指定した領域がタッチされ終えたかどうか

IsTouchEnded(float, float) ​

継承元: IInputPointerEx

csharp
bool IsTouchEnded(out float x, out float y)

前回のフレーム処理以降 タッチされ終えたかどうか

パラメーター

  • x — タッチ位置 X座標
  • y — タッチ位置 Y座標

戻り値

タッチされ終えたかどうか

IsTouchEnded(float2) ​

継承元: IInputPointerEx

csharp
bool IsTouchEnded(out float2 point)

前回のフレーム処理以降 タッチされ終えたかどうか

パラメーター

  • point — タッチ位置

戻り値

タッチされ終えたかどうか

IsTouchEnded(GcAABB, float2) ​

継承元: IInputPointerEx

csharp
bool IsTouchEnded(in GcAABB aabb, out float2 point)

前回のフレーム処理以降 指定した領域がタッチされ終えたかどうか

パラメーター

  • aabb — 領域
  • point — タッチ位置

戻り値

指定した領域がタッチされ終えたかどうか

IsTouchEnded(GcPointerEvent) ​

継承元: IInputPointerEx

csharp
bool IsTouchEnded(out GcPointerEvent e)

前回のフレーム処理以降 タッチされ終えたかどうか

パラメーター

  • pointer — ポインターイベント

戻り値

タッチされ終えたかどうか

IsTouchEnded(GcPointerTrace) ​

継承元: IInputPointerEx

csharp
bool IsTouchEnded(out GcPointerTrace trace)

前回のフレーム処理以降 タッチされ終えたかどうか

パラメーター

  • pointer — タッチの軌跡

戻り値

タッチされ終えたかどうか

Max(float, float) ​

継承元: IMath

csharp
float Max(in float a, in float b)

2つの値を比較して、より大きい方を返します

戻り値

大きい方の値

Min(float, float) ​

継承元: IMath

csharp
float Min(in float a, in float b)

2つの値を比較して、より小さい方を返します

戻り値

小さい方の値

PauseCameraImage(GcCameraDevice) ​

継承元: IInputCamera

csharp
bool PauseCameraImage(in GcCameraDevice camera)

指定されたカメラ（外部入力映像）の更新処理を一時停止します

パラメーター

  • camera — カメラ（外部入力映像）

戻り値

停止したかどうか（元から停止していた場合を含まない）

PauseSound(GcSoundTrack) ​

継承元: ISound

csharp
void PauseSound(GcSoundTrack track = GcSoundTrack.BGM1)

指定された音声トラックのサウンドを一時停止します

備考

BGMトラック以外では常に無視されます

パラメーター

  • track — 対象の音声トラック

PlayCameraImage(GcCameraDevice, GcResolution, int2) ​

継承元: IInputCamera

csharp
bool PlayCameraImage(in GcCameraDevice camera, in GcResolution request, out int2 resolution)

指定されたカメラ（外部入力映像）の更新処理を開始します

備考

  • カメラごとにこのAPIを呼び出すことで、それらを同時に更新することが可能です
  • ただし、同じ名称のカメラは、同時に更新することができません
  • 既にテクスチャーが生成済みの場合は、request引数の値は無視されます
  • 生成後に解像度を変更する場合は TryChangeCameraImageResolution 関数を呼び出してください

パラメーター

  • camera — カメラ（外部入力映像）
  • request — テクスチャーが未生成だった場合に、希望する解像度とリフレッシュレート
  • resolution — カメラ（外部入力映像）の解像度

戻り値

開始したかどうか（元から更新していた場合を含まない）

PlayCameraImage(GcCameraDevice, int2) ​

継承元: IInputCameraEx

csharp
bool PlayCameraImage(in GcCameraDevice camera, out int2 resolution)

指定されたカメラ（外部入力映像）の更新処理を開始します

備考

  • カメラごとにこのAPIを呼び出すことで、それらを同時に更新することが可能です
  • ただし、同じ名称のカメラは、同時に更新することができません
  • テクスチャーが未生成だった場合は、内部で勝手に適当な解像度で生成します

パラメーター

  • camera — カメラ（外部入力映像）
  • resolution — カメラ（外部入力映像）の解像度

戻り値

開始したかどうか（元から更新していた場合を含まない）

PlayCameraImage(GcCameraDevice) ​

継承元: IInputCameraEx

csharp
bool PlayCameraImage(in GcCameraDevice camera)

指定されたカメラ（外部入力映像）の更新処理を開始します

備考

  • カメラごとにこのAPIを呼び出すことで、それらを同時に更新することが可能です
  • ただし、同じ名称のカメラは、同時に更新することができません

パラメーター

  • camera — カメラ（外部入力映像）

戻り値

開始したかどうか（元から更新していた場合を含まない）

PlaySE(AudioClip) ​

継承元: ISoundEx

csharp
void PlaySE(in AudioClip clip)

サウンドを1回再生します

パラメーター

  • clip — サウンド

PlaySE(GcSound) ​

継承元: ISoundEx

csharp
void PlaySE(in GcSound sound)

サウンドを1回再生します

パラメーター

  • sound — サウンド

PlaySound(AudioClip, GcSoundTrack, bool) ​

継承元: ISound

csharp
void PlaySound(in AudioClip clip, GcSoundTrack track = GcSoundTrack.BGM1, bool loop = false)

サウンドを再生します

パラメーター

  • clip — サウンド
  • track — 対象の音声トラック
  • loop — ループ再生するかどうか（SEトラック以外）

PlaySound(GcSound, GcSoundTrack, bool) ​

継承元: ISound

csharp
void PlaySound(in GcSound sound, GcSoundTrack track = GcSoundTrack.BGM1, bool loop = false)

サウンドを再生します

パラメーター

  • soundId — サウンド
  • track — 対象の音声トラック
  • loop — ループ再生するかどうか（SEトラック以外）

PopCoordinate() ​

継承元: IGraphics

csharp
void PopCoordinate()

スタックから座標系（変換行列）を取り出し CurrentCoordinate に上書きします

PopStyle() ​

継承元: IGraphics

csharp
void PopStyle()

スタックから描画スタイルを取り出し CurrentStyle に上書きします

PushCoordinate() ​

継承元: IGraphics

csharp
void PushCoordinate()

CurrentCoordinate をスタックに保存します

PushStyle() ​

継承元: IGraphics

csharp
void PushStyle()

CurrentStyle をスタックに保存します

Random() ​

継承元: IMath

csharp
float Random()

0以上1未満のランダムな値を算出します

戻り値

ランダムな値

Random(float, float) ​

継承元: IMath

csharp
float Random(in float min, in float max)

min以上max未満のランダムな値を算出します

パラメーター

  • min — 最小値
  • max — 最大値

戻り値

ランダムな値

Random(int, int) ​

継承元: IMath

csharp
int Random(in int min, in int max)

min以上max以下のランダムな値を算出します

パラメーター

  • min — 最小値
  • max — 最大値

戻り値

ランダムな値

RebuildFontTexture() ​

継承元: IGraphics

csharp
void RebuildFontTexture()

フォントテクスチャ―を再生成します

備考

  • テキスト描画が乱れた場合にのみ呼び出すことを想定しています
  • 実際に再生成が行われるのは、この関数を呼び出した次のフレームの冒頭です

RegisterScene(GcScene) ​

継承元: ISceneManagementEx

csharp
void RegisterScene(in GcScene scene)

新たなシーンを登録します

備考

登録したシーンは ChangeScene を呼び出すことで有効になります

パラメーター

  • scene — 登録するシーン

RegisterScene<T>() ​

継承元: ISceneManagementEx

csharp
void RegisterScene<T>() where T : GcScene, new()

新たなシーンを登録します

備考

登録したシーンは ChangeScene を呼び出すことで有効になります

型パラメーター

  • T — 登録するシーンの型

RemoveActorAll() ​

継承元: ISceneManagement

csharp
void RemoveActorAll()

シーンに登録されているすべてのアクターを登録解除します

Repeat(float, float) ​

継承元: IMath

csharp
float Repeat(in float value, in float max)

値を 0 から max までの範囲を繰り返すよう値を丸めます

パラメーター

  • value — 入力値
  • max — 最大値

RequestUserAuthorizedPermissionCameraAsync(System.Action<bool>) ​

継承元: IInputCamera

csharp
void RequestUserAuthorizedPermissionCameraAsync(in System.Action<bool> callback)

カメラデバイスへのアクセス権限を要求します

パラメーター

  • callback — 結果を通知するコールバック

RequestUserAuthorizedPermissionGeolocationAsync(System.Action<bool>) ​

継承元: IInputGeolocation

csharp
void RequestUserAuthorizedPermissionGeolocationAsync(in System.Action<bool> callback)

位置情報へのアクセス権限を要求します

パラメーター

  • callback — 結果を通知するコールバック

RotateCoordinate(float, float, float) ​

継承元: IGraphicsEx

csharp
void RotateCoordinate(in float degree, in float originX, in float originY)

座標系（変換行列）を回転させます

パラメーター

  • degree — 回転量（度数法）
  • originX — 回転中心のX座標
  • originY — 回転中心のY座標

RotateCoordinate(float, float2) ​

継承元: IGraphics

csharp
void RotateCoordinate(in float degree, in float2 origin)

座標系（変換行列）を指定した座標を中心に回転させます

パラメーター

  • degree — 回転量（度数法）
  • origin — 回転中心

RotateCoordinate(float) ​

継承元: IGraphics

csharp
void RotateCoordinate(in float degree)

座標系（変換行列）を回転させます

パラメーター

  • degree — 回転量（度数法）

RotateVector(float2, float) ​

継承元: IMath

csharp
float2 RotateVector(in float2 vector, in float degree)

ベクトルを回転します

パラメーター

  • vector — ベクトル
  • degree — 回転量（度数法）

戻り値

回転後のベクトル

Round(double) ​

継承元: IMath

csharp
int Round(in double value)

値を四捨五入します

パラメーター

  • value — 入力値

戻り値

四捨五入された値

Round(float) ​

継承元: IMath

csharp
int Round(in float value)

値を四捨五入します

パラメーター

  • value — 入力値

戻り値

四捨五入された値

Save(string, float?) ​

継承元: IStorage

csharp
void Save(in string key, float? value)

ローカルストレージに値を保存します

備考

value に null を渡した場合、キーに紐づくデータを削除します

パラメーター

  • key — キー
  • value — 保存する値

Save(string, int?) ​

継承元: IStorage

csharp
void Save(in string key, int? value)

ローカルストレージに値を保存します

備考

value に null を渡した場合、キーに紐づくデータを削除します

パラメーター

  • key — キー
  • value — 保存する値

Save(string, string?) ​

継承元: IStorage

csharp
void Save(in string key, string? value)

ローカルストレージに値を保存します

備考

value に null を渡した場合、キーに紐づくデータを削除します

パラメーター

  • key — キー
  • value — 保存する値

SaveScreenshotAsync(System.Action<string?>?) ​

継承元: IStorage

csharp
void SaveScreenshotAsync(System.Action<string?>? onComplete = null)

現在の画面を 画像として保存します

備考

  • 保存に成功した場合、onComplete の引数には、画像保存先のパスが渡されます
  • 保存に失敗した場合、onComplete の引数には null が渡されます

パラメーター

  • onComplete — 保存完了後に呼び出されるコールバック

ScaleCoordinate(float, float) ​

継承元: IGraphicsEx

csharp
void ScaleCoordinate(in float sx, in float sy)

座標系（変換行列）を拡縮させます

パラメーター

  • sx — X軸方向の拡縮率
  • sy — Y軸方向の拡縮率

ScaleCoordinate(float2) ​

継承元: IGraphics

csharp
void ScaleCoordinate(in float2 scaling)

座標系（変換行列）を拡縮させます

パラメーター

  • scaling — 拡縮率

ScreenToCanvasPoint(float2, float2) ​

継承元: IGraphics

csharp
void ScreenToCanvasPoint(in float2 screen, out float2 canvas)

端末スクリーン座標をキャンバス座標に変換します

パラメーター

  • screen — 変換元 端末スクリーン座標
  • canvas — 変換後 キャンバス座標

ScreenToCanvasPoint(float2, int2) ​

継承元: IGraphics

csharp
void ScreenToCanvasPoint(in float2 screen, out int2 canvas)

端末スクリーン座標をキャンバス座標に変換します

パラメーター

  • screen — 変換元 端末スクリーン座標
  • canvas — 変換後 キャンバス座標

SetBackgroundColor(Color) ​

継承元: IGraphicsEx

csharp
void SetBackgroundColor(in Color color)

背景色を指定します

パラメーター

  • color — 背景色

SetBackgroundColor(float, float, float) ​

継承元: IGraphicsEx

csharp
void SetBackgroundColor(in float r, in float g, in float b)

背景色を指定します

パラメーター

  • r — 背景色の赤成分
  • g — 背景色の緑成分
  • b — 背景色の青成分

SetColor(byte, byte, byte, byte) ​

継承元: IGraphicsEx

csharp
void SetColor(in byte r, in byte g, in byte b, byte a = 255)

描画色を指定します

パラメーター

  • r — 描画色の赤成分
  • g — 描画色の緑成分
  • b — 描画色の青成分
  • a — 描画色の不透明度

SetColor(Color, float) ​

継承元: IGraphicsEx

csharp
void SetColor(in Color color, in float alpha)

描画色を指定します

パラメーター

  • color — 描画色
  • alpha — 描画色の不透明度

SetColor(Color) ​

継承元: IGraphicsEx

csharp
void SetColor(in Color color)

描画色を指定します

パラメーター

  • color — 描画色

SetColor(float, float, float, float) ​

継承元: IGraphicsEx

csharp
void SetColor(in float r, in float g, in float b, float a = 1f)

描画色を指定します

パラメーター

  • r — 描画色の赤成分
  • g — 描画色の緑成分
  • b — 描画色の青成分
  • a — 描画色の不透明度

SetCoordinate(float2x3) ​

継承元: IGraphicsEx

csharp
void SetCoordinate(in float2x3 matrix)

座標系（変換行列）を指定します

パラメーター

  • matrix — 座標系（変換行列）

SetFont(GcFont) ​

継承元: IGraphicsEx

csharp
void SetFont(in GcFont font)

フォントを指定します

パラメーター

  • font — フォント

SetFontSize(int) ​

継承元: IGraphicsEx

csharp
void SetFontSize(in int fontSize)

フォントサイズを指定します

パラメーター

  • fontSize — フォントサイズ

SetFrameInterval(double, bool) ​

継承元: ITime

csharp
void SetFrameInterval(in double targetDeltaTime, bool vSyncEnabled = true)

UpdateGame や DrawGame が呼び出される時間間隔を設定します。

備考

垂直同期を無効にした場合、間隔の揺らぎは減少しますが、ディスプレイのリフレッシュレートを常に無視して描画するため、画面のちらつきが発生する場合があります。

パラメーター

  • targetDeltaTime — フレーム更新間隔の目標値（秒）
  • vSyncEnabled — 垂直同期の有無

SetFrameRate(int, bool) ​

継承元: ITime

csharp
void SetFrameRate(in int targetFrameRate, bool vSyncEnabled = true)

フレームレートの目標値を設定します。

小数点以下を指定したい場合は、この関数の代わりに SetFrameInterval を使用してください。

備考

垂直同期を無効にした場合、間隔の揺らぎは減少しますが、ディスプレイのリフレッシュレートを常に無視して描画するため、画面のちらつきが発生する場合があります。

パラメーター

  • targetFrameRate — フレームレート（1秒あたりのフレーム数）の目標値
  • vSyncEnabled — 垂直同期の有無

SetLineCap(GcLineCap) ​

継承元: IGraphicsEx

csharp
void SetLineCap(in GcLineCap lineCap)

描線の端点の形状を指定します

パラメーター

  • lineCap — 描線の端点の形状

SetLineWidth(float) ​

継承元: IGraphicsEx

csharp
void SetLineWidth(in float lineWidth)

描線の太さを指定します

パラメーター

  • lineWidth — 描線の太さ

SetRandomSeed(uint) ​

継承元: IMath

csharp
void SetRandomSeed(in uint seed)

乱数計算のシード値を設定します

パラメーター

  • seed — シード値

SetRandomSeedByIndex(uint) ​

継承元: IMath

csharp
void SetRandomSeedByIndex(in uint index)

乱数計算のシード値をインデックスから設定します

パラメーター

  • index — インデックス

SetRectAnchor(GcAnchor) ​

継承元: IGraphicsEx

csharp
void SetRectAnchor(in GcAnchor anchor)

矩形や画像のアンカー位置を指定します

パラメーター

  • anchor — アンカー位置

SetSoundLevel(float, GcSoundTrack) ​

継承元: ISound

csharp
void SetSoundLevel(in float decibel, GcSoundTrack track = GcSoundTrack.Master)

トラック音量を変更します

パラメーター

  • decibel — 音量（-96db～20db）
  • track — 対象の音声トラック

SetSoundVolume(float, GcSoundTrack) ​

継承元: ISoundEx

csharp
void SetSoundVolume(in float volume, GcSoundTrack track = GcSoundTrack.Master)

トラック音量を変更します

パラメーター

  • volume — 音量（0f～1f）
  • track — 対象の音声トラック

SetStringAnchor(GcAnchor) ​

継承元: IGraphicsEx

csharp
void SetStringAnchor(in GcAnchor anchor)

文字列のアンカー位置を指定します

パラメーター

  • anchor — アンカー位置

SetStyle(GcStyle) ​

継承元: IGraphicsEx

csharp
void SetStyle(in GcStyle style)

スタイルを指定します

パラメーター

  • style —

ShowScreenKeyboard() ​

継承元: IInputKey

csharp
bool ShowScreenKeyboard()

スクリーンキーボードを表示します

戻り値

表示できたかどうか

Sin(float) ​

継承元: IMath

csharp
float Sin(in float degree)

サインを計算します

パラメーター

  • degree — 角度（度数法）

戻り値

サイン

Sqrt(float) ​

継承元: IMath

csharp
float Sqrt(in float value)

平方根を計算します

パラメーター

  • value — 入力値

戻り値

平方根

StartGeolocationService(float, float) ​

継承元: IInputGeolocation

csharp
void StartGeolocationService(float desiredAccuracy = 10f, float updateDistance = 10f)

位置情報サービスを起動します

備考

位置情報へのアクセス権限がない場合、この処理は失敗します

パラメーター

  • desiredAccuracy — 望ましいサービス精度（メートル単位）
  • updateDistance — 位置情報の更新に必要な最小移動距離（メートル単位）

StopCameraImage(GcCameraDevice) ​

継承元: IInputCamera

csharp
void StopCameraImage(in GcCameraDevice camera)

指定されたカメラ（外部入力映像）の更新処理を完全に停止します

パラメーター

  • camera — カメラ（外部入力映像）

StopGeolocationService() ​

継承元: IInputGeolocation

csharp
void StopGeolocationService()

位置情報サービスを停止します

StopSound(GcSoundTrack) ​

継承元: ISound

csharp
void StopSound(GcSoundTrack track = GcSoundTrack.BGM1)

指定された音声トラックのサウンドを停止します

備考

BGMトラック以外では常に無視されます

パラメーター

  • track — 対象の音声トラック

SweepTest(GcAABB, float2, float2, GcSweepResult) ​

継承元: IPhysics

csharp
bool SweepTest(in GcAABB @static, in float2 @dynamic, in float2 delta, out GcSweepResult hit)

移動する点と静的な矩形の連続衝突検出

SweepTest(GcAABB, GcAABB, float2, GcSweepResult) ​

継承元: IPhysics

csharp
bool SweepTest(in GcAABB @static, in GcAABB @dynamic, in float2 delta, out GcSweepResult hit)

移動する矩形と静的な矩形の連続衝突検出

TranslateCoordinate(float, float) ​

継承元: IGraphicsEx

csharp
void TranslateCoordinate(in float tx, in float ty)

座標系（変換行列）を平行移動させます

パラメーター

  • tx — X軸方向の移動量
  • ty — Y軸方向の移動量

TranslateCoordinate(float2) ​

継承元: IGraphics

csharp
void TranslateCoordinate(in float2 translation)

座標系（変換行列）を平行移動させます

パラメーター

  • translation — 移動量

TryChangeCameraImageResolution(GcCameraDevice, GcResolution) ​

継承元: IInputCamera

csharp
int2 TryChangeCameraImageResolution(in GcCameraDevice camera, in GcResolution request)

指定されたカメラ（外部入力映像）の解像度変更を試みます

パラメーター

  • camera — カメラ（外部入力映像）
  • request — 希望する解像度とリフレッシュレート

戻り値

実際に設定された解像度

TryGetAccelerationEvent(int, GcAccelerationEvent) ​

継承元: IInputAcceleration

csharp
bool TryGetAccelerationEvent(int i, out GcAccelerationEvent e)

前回のフレーム処理以降に検出した 加速度イベントの取得を試みます

パラメーター

  • i — イベントインデックス（0 から AccelerationEventCount-1 までの連番）
  • e — イベント

戻り値

ポインターイベントを取得できたかどうか

TryGetAccelerationEventAll(System.ReadOnlySpan<GcAccelerationEvent>) ​

継承元: IInputAcceleration

csharp
bool TryGetAccelerationEventAll(out System.ReadOnlySpan<GcAccelerationEvent> events)

前回のフレーム処理以降に検出した 加速度イベントの取得を試みます

パラメーター

  • events — イベント配列

戻り値

1つ以上の加速度イベントがあったかどうか

TryGetActor(int, GcActor?) ​

継承元: ISceneManagement

csharp
bool TryGetActor(in int i, [NotNullWhen(true)] out GcActor? actor)

シーンに登録されているアクターを 1つだけ取得します

型パラメーター

  • T — 取得するアクターの型

パラメーター

  • i — 取得するアクターのインデックス（0以上GetActorCount未満）
  • actor — 取得できたアクター

戻り値

取得できたかどうか

TryGetActor<T>(int, T?) ​

継承元: ISceneManagement

csharp
bool TryGetActor<T>(in int i, [NotNullWhen(true)] out T? actor) where T : GcActor

シーンに登録されているアクターを 1つだけ取得します

型パラメーター

  • T — 取得するアクターの型

パラメーター

  • i — 取得するアクターのインデックス（0以上GetActorCount{T}未満）
  • actor — 取得できたアクター

戻り値

取得できたかどうか

TryGetActorAll<T>(System.ReadOnlySpan<T>) ​

継承元: ISceneManagement

csharp
bool TryGetActorAll<T>(out System.ReadOnlySpan<T> actors) where T : GcActor

シーンに登録されているアクターのうち、指定した型のものを取得します

型パラメーター

  • T — 取得するアクターの型

パラメーター

  • actors — 取得したアクターの一覧

戻り値

1つ以上 取得できたかどうか

TryGetCameraImage(GcCameraDevice?) ​

継承元: IInputCamera

csharp
bool TryGetCameraImage([NotNullWhen(true)] out GcCameraDevice? camera)

カメラ（外部入力映像）の取得を試みます

パラメーター

  • camera — カメラ（外部入力映像）

戻り値

取得できたかどうか

TryGetCameraImage(string, GcCameraDevice?) ​

継承元: IInputCamera

csharp
bool TryGetCameraImage(in string deviceName, [NotNullWhen(true)] out GcCameraDevice? camera)

デバイス名を指定して、カメラ（外部入力映像）の取得を試みます

パラメーター

  • deviceName — デバイス名
  • camera — カメラ（外部入力映像）

戻り値

取得できたかどうか

TryGetCameraImageAll(System.ReadOnlySpan<GcCameraDevice>) ​

継承元: IInputCamera

csharp
bool TryGetCameraImageAll(out System.ReadOnlySpan<GcCameraDevice> devices)

全ての認識可能なカメラ（外部入力映像）の取得を試みます

パラメーター

  • devices — カメラ（外部入力映像）の一覧

戻り値

1つ以上 取得できたかどうか

TryGetCameraImageRotation(GcCameraDevice, float) ​

継承元: IInputCamera

csharp
bool TryGetCameraImageRotation(in GcCameraDevice camera, out float degree)

指定されたカメラ（外部入力映像）の回転角度取得を試みます

パラメーター

  • camera — カメラ（外部入力映像）
  • degree — 回転角度

戻り値

取得できたかどうか

TryGetCameraImageSize(GcCameraDevice, int2) ​

継承元: IInputCamera

csharp
bool TryGetCameraImageSize(in GcCameraDevice camera, out int2 resolution)

指定されたカメラ（外部入力映像）の解像度取得を試みます

備考

  • テクスチャーが未生成の場合は、取得に失敗します
  • テクスチャーを生成するには、PlayCameraImage もしくは GetOrCreateCameraTexture 関数を呼び出してください

パラメーター

  • camera — カメラ（外部入力映像）
  • resolution — カメラ（外部入力映像）の解像度

戻り値

取得できたかどうか

TryGetGeolocationEvent(GcGeolocationEvent) ​

継承元: IInputGeolocation

csharp
bool TryGetGeolocationEvent(out GcGeolocationEvent e)

前回のフレーム処理以降にあった 位置情報イベントの取得を試みます

パラメーター

  • e — 位置情報イベント

戻り値

前回のフレーム処理以降に 位置情報イベントがあったかどうか

TryGetKeyEvent(Key, GcKeyEvent) ​

継承元: IInputKey

csharp
bool TryGetKeyEvent(in Key key, out GcKeyEvent e)

指定されたキーのキーイベントがあれば取得します

パラメーター

  • key — キー
  • e — キーイベント

戻り値

取得できたかどうか

TryGetKeyEventAll(GcKeyEventPhase, System.ReadOnlySpan<GcKeyEvent>) ​

継承元: IInputKey

csharp
bool TryGetKeyEventAll(in GcKeyEventPhase phase, out System.ReadOnlySpan<GcKeyEvent> events)

前回のフレーム処理以降に更新された 指定された状態のキーイベント全てを取得します

パラメーター

  • phase — キーイベント状態
  • events — キーイベントの一覧

戻り値

要素数が1以上かどうか

TryGetKeyEventAll(System.ReadOnlySpan<GcKeyEvent>) ​

継承元: IInputKey

csharp
bool TryGetKeyEventAll(out System.ReadOnlySpan<GcKeyEvent> events)

前回のフレーム処理以降に更新された キーイベント全てを取得します

パラメーター

  • events — キーイベントの一覧

戻り値

要素数が1以上かどうか

TryGetKeyTrace(Key, GcKeyTrace) ​

継承元: IInputKey

csharp
bool TryGetKeyTrace(in Key key, out GcKeyTrace trace)

指定されたキーの軌跡があれば取得します

パラメーター

  • key — キー
  • trace — キーの軌跡

戻り値

取得できたかどうか

TryGetKeyTraceAll(GcKeyEventPhase, System.ReadOnlySpan<GcKeyTrace>) ​

継承元: IInputKey

csharp
bool TryGetKeyTraceAll(in GcKeyEventPhase phase, out System.ReadOnlySpan<GcKeyTrace> traces)

前回のフレーム処理以降に更新された キーの軌跡全てを取得します

パラメーター

  • phase — キーイベント状態
  • traces — キーの軌跡の一覧

戻り値

要素数が1以上かどうか

TryGetKeyTraceAll(System.ReadOnlySpan<GcKeyTrace>) ​

継承元: IInputKey

csharp
bool TryGetKeyTraceAll(out System.ReadOnlySpan<GcKeyTrace> traces)

前回のフレーム処理以降に更新された キーの軌跡全てを取得します

パラメーター

  • traces — キーの軌跡の一覧

戻り値

要素数が1以上かどうか

TryGetOnlineImage(string, GcAvailability, Texture2D?) ​

継承元: INetwork

csharp
bool TryGetOnlineImage(in string url, out GcAvailability availability, [NotNullWhen(true)] out Texture2D? texture)

オンライン画像リソースの取得を試みます

パラメーター

  • url — リソースURL
  • texture — 画像リソース。戻り値がGcAvailability.Ready以外だとNull

戻り値

オンラインリソースの可用性

TryGetOnlineImageSize(string, int2) ​

継承元: INetwork

csharp
bool TryGetOnlineImageSize(in string url, out int2 size)

オンライン画像リソースの寸法を取得します

パラメーター

  • url — リソースURL
  • size — オンライン画像リソースの寸法

戻り値

オンラインリソースを取得できたかどうか

TryGetOnlineSound(string, AudioType, GcAvailability, AudioClip?) ​

継承元: INetwork

csharp
bool TryGetOnlineSound(in string url, in AudioType type, out GcAvailability availability, [NotNullWhen(true)] out AudioClip? clip)

オンライン音声リソースの取得を試みます

パラメーター

  • url — リソースURL
  • type — 音声リソースの形式
  • clip — 音声リソース。戻り値がGcAvailability.Ready以外だとNull

戻り値

オンラインリソースの可用性

TryGetOnlineSound(string, GcAvailability, AudioClip?) ​

継承元: INetwork

csharp
bool TryGetOnlineSound(in string url, out GcAvailability availability, [NotNullWhen(true)] out AudioClip? clip)

オンライン音声リソースの取得を試みます

パラメーター

  • url — リソースURL
  • clip — 音声リソース。戻り値がGcAvailability.Ready以外だとNull

戻り値

オンラインリソースの可用性

TryGetOnlineText(string, GcAvailability, string?) ​

継承元: INetwork

csharp
bool TryGetOnlineText(in string url, out GcAvailability availability, [NotNullWhen(true)] out string? str)

オンラインテキストの取得を試みます

パラメーター

戻り値

オンラインリソースの可用性

TryGetPointerEvent(GcPointerEventPhase, int, GcPointerEvent) ​

継承元: IInputPointer

csharp
bool TryGetPointerEvent(in GcPointerEventPhase phase, in int i, out GcPointerEvent e)

前回のフレーム処理以降に検出した ポインターイベントのうち、1つを取得します

パラメーター

  • phase — イベント状態
  • i — イベントインデックス（イベントIDではない）
  • e — イベント

戻り値

取得できたかどうか

TryGetPointerEvent(int, GcPointerEvent) ​

継承元: IInputPointer

csharp
bool TryGetPointerEvent(in int i, out GcPointerEvent e)

前回のフレーム処理以降に検出した ポインターイベントのうち、1つを取得します

パラメーター

  • i — イベントインデックス（0 から PointerCount-1 までの連番。イベントIDではない）
  • e — イベント

戻り値

取得できたかどうか

TryGetPointerEventAll(GcPointerEventPhase, System.ReadOnlySpan<GcPointerEvent>) ​

継承元: IInputPointer

csharp
bool TryGetPointerEventAll(in GcPointerEventPhase phase, out System.ReadOnlySpan<GcPointerEvent> events)

前回のフレーム処理以降に検出した 指定された状態のポインターイベント全てを取得します

パラメーター

  • phase — イベント状態
  • events — イベントの一覧

戻り値

1つ以上 取得できたかどうか

TryGetPointerEventAll(System.ReadOnlySpan<GcPointerEvent>) ​

継承元: IInputPointer

csharp
bool TryGetPointerEventAll(out System.ReadOnlySpan<GcPointerEvent> events)

前回のフレーム処理以降に検出した ポインターイベント全てを取得します

パラメーター

  • events — イベントの一覧

戻り値

1つ以上 取得できたかどうか

TryGetPointerTapPoint(int, float2) ​

継承元: IInputPointer

csharp
bool TryGetPointerTapPoint(in int i, out float2 point)

前回のフレーム処理以降に検出した タップポイントのうち、1つを取得します

パラメーター

  • i — タップインデックス
  • point — タップポイント

戻り値

取得できたかどうか

TryGetPointerTapPointAll(System.ReadOnlySpan<float2>) ​

継承元: IInputPointer

csharp
bool TryGetPointerTapPointAll(out System.ReadOnlySpan<float2> points)

前回のフレーム処理以降に検出した タップポイント全てを取得します

パラメーター

  • points — タップポイントの一覧

戻り値

1つ以上 取得できたかどうか

TryGetPointerTrace(GcPointerEventPhase, int, GcPointerTrace) ​

継承元: IInputPointer

csharp
bool TryGetPointerTrace(in GcPointerEventPhase phase, in int i, out GcPointerTrace trace)

現在有効なポインターのうち、1つの軌跡を取得します

備考

phase に指定できる値は GcPointerEventPhase.Hold または GcPointerEventPhase.End のみです

パラメーター

  • phase — イベント状態
  • i — イベントインデックス（イベントIDではない）
  • trace — 軌跡

戻り値

取得できたかどうか

TryGetPointerTrace(int, GcPointerTrace) ​

継承元: IInputPointer

csharp
bool TryGetPointerTrace(in int i, out GcPointerTrace trace)

現在有効なポインターのうち、1つの軌跡を取得します

パラメーター

  • i — イベントインデックス（0 から PointerCount-1 までの連番。イベントIDではない）
  • trace — 軌跡

戻り値

取得できたかどうか

TryGetPointerTraceAll(GcPointerEventPhase, System.ReadOnlySpan<GcPointerTrace>) ​

継承元: IInputPointer

csharp
bool TryGetPointerTraceAll(in GcPointerEventPhase phase, out System.ReadOnlySpan<GcPointerTrace> traces)

前回のフレーム処理以降に検出した 指定された状態のポインターの軌跡全てを取得します

備考

phase に指定できる値は GcPointerEventPhase.Hold または GcPointerEventPhase.End のみです

パラメーター

  • traces — 軌跡の一覧

戻り値

1つ以上 取得できたかどうか

TryGetPointerTraceAll(System.ReadOnlySpan<GcPointerTrace>) ​

継承元: IInputPointer

csharp
bool TryGetPointerTraceAll(out System.ReadOnlySpan<GcPointerTrace> traces)

前回のフレーム処理以降に検出した ポインターの軌跡全てを取得します

パラメーター

  • traces — 軌跡の一覧

戻り値

1つ以上 取得できたかどうか

TryGetScreenKeyboardArea(GcAABB) ​

継承元: IInputKey

csharp
bool TryGetScreenKeyboardArea(out GcAABB area)

スクリーンキーボードの表示位置を取得します

備考

  • 表示中のみ取得できます
  • 表示直後のアニメーション中は取得できません
  • Android OSでは取得できません

パラメーター

  • area — 表示位置（キャンバス座標系）

戻り値

取得できたかどうか

TryLoad(string, float) ​

継承元: IStorage

csharp
bool TryLoad(in string key, out float value)

ローカルストレージに保存された値を取り出します

パラメーター

  • key — キー
  • value — 取り出した値

戻り値

取り出せたかどうか

TryLoad(string, int) ​

継承元: IStorage

csharp
bool TryLoad(in string key, out int value)

ローカルストレージに保存された値を取り出します

パラメーター

  • key — キー
  • value — 取り出した値

戻り値

取り出せたかどうか

TryLoad(string, string?) ​

継承元: IStorage

csharp
bool TryLoad(in string key, [NotNullWhen(true)] out string? value)

ローカルストレージに保存された値を取り出します

パラメーター

  • key — キー
  • value — 取り出した値

戻り値

取り出せたかどうか

TryRemoveActor(GcActor) ​

継承元: ISceneManagement

csharp
bool TryRemoveActor(in GcActor actor)

指定したアクターをシーンから登録解除します

パラメーター

  • actor — 登録解除するアクター

戻り値

登録解除できたかどうか

UnpauseSound(GcSoundTrack) ​

継承元: ISound

csharp
void UnpauseSound(GcSoundTrack track = GcSoundTrack.BGM1)

指定された音声トラックのサウンドを一時停止していた場合、再生を再開します

備考

BGMトラック以外では常に無視されます

パラメーター

  • track — 対象の音声トラック

UnregisterScene(GcScene) ​

継承元: ISceneManagementEx

csharp
void UnregisterScene(in GcScene scene)

指定したシーンをシーン一覧から削除します

備考

もし指定したシーンが現在有効なシーンだった場合、フレームの最後にシーンの離脱処理が走ります

パラメーター

  • scene — 削除するシーン

UnregisterScene<T>() ​

継承元: ISceneManagementEx

csharp
void UnregisterScene<T>() where T : GcScene

指定したシーンをシーン一覧から削除します

備考

もし指定したシーンが現在有効なシーンだった場合、フレームの最後にシーンの離脱処理が走ります

型パラメーター

  • T — 削除するシーンの型

UpdateCameraDevice() ​

継承元: IInputCamera

csharp
int UpdateCameraDevice()

カメラ（外部入力映像）の一覧を更新します

戻り値

更新後の 認識可能なカメラ（外部入力映像）の数

Released under the MIT License.

Copyright © 2015-2026 Smart Device Programming.