Table of Contents

Class GcProxy

Namespace
GameCanvas
Assembly
GameCanvas.dll

ユーザー定義クラスからGameCanvasの機能を呼び出すためのクラス

GameCanvas API

gc.*** で呼べる関数の一覧です

public sealed class GcProxy : IGameCanvas, IGraphicsEx, IGraphics, ISoundEx, ISound, INetworkEx, INetwork, ISceneManagementEx, ISceneManagement, ITimeEx, ITime, IPhysicsEx, IPhysics, IStorageEx, IStorage, IMathEx, IMath, IInputPointerEx, IInputPointer, IInputKeyEx, IInputKey, IInputAccelerationEx, IInputAcceleration, IInputGeolocationEx, IInputGeolocation, IInputCameraEx, IInputCamera
Inheritance
GcProxy
Implements
Inherited Members

Properties

AccelerationEventCount

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

public int AccelerationEventCount { get; }

Property Value

int

AccelerationEvents

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

public ReadOnlySpan<GcAccelerationEvent> AccelerationEvents { get; }

Property Value

ReadOnlySpan<GcAccelerationEvent>

AccelerometerSamplingRate

加速度計の動作周波数

public float AccelerometerSamplingRate { get; set; }

Property Value

float

BackgroundColor

背景色

public Color BackgroundColor { get; set; }

Property Value

Color

BorderColor

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

public Color BorderColor { get; }

Property Value

Color

Remarks

ChangeBorderColor(in Color) を呼び出すことで変更できます

CameraDeviceCount

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

public int CameraDeviceCount { get; }

Property Value

int

CameraDevices

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

public ReadOnlySpan<GcCameraDevice> CameraDevices { get; }

Property Value

ReadOnlySpan<GcCameraDevice>

CanvasAABB

キャンバスのAABB

public GcAABB CanvasAABB { get; }

Property Value

GcAABB

CanvasCenter

キャンバスの中心座標

public float2 CanvasCenter { get; }

Property Value

float2

CanvasHeight

キャンバスの縦幅

public int CanvasHeight { get; }

Property Value

int

CanvasResolution

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

public GcResolution CanvasResolution { get; }

Property Value

GcResolution

CanvasSize

キャンバス解像度

public int2 CanvasSize { get; }

Property Value

int2

Remarks

ChangeCanvasSize(in int2) を呼び出すことで変更できます

CanvasWidth

キャンバスの横幅

public int CanvasWidth { get; }

Property Value

int

CircleResolution

円の解像度

public int CircleResolution { get; set; }

Property Value

int

Color

描画色

public Color Color { get; set; }

Property Value

Color

ColorAqua

水色

public Color ColorAqua { get; }

Property Value

Color

ColorBlack

黒色

public Color ColorBlack { get; }

Property Value

Color

ColorBlue

青色

public Color ColorBlue { get; }

Property Value

Color

ColorCyan

シアン

public Color ColorCyan { get; }

Property Value

Color

ColorGray

灰色

public Color ColorGray { get; }

Property Value

Color

ColorGreen

緑色

public Color ColorGreen { get; }

Property Value

Color

ColorPurple

紫色

public Color ColorPurple { get; }

Property Value

Color

ColorRed

赤色

public Color ColorRed { get; }

Property Value

Color

ColorWhite

白色

public Color ColorWhite { get; }

Property Value

Color

ColorYellow

黄色

public Color ColorYellow { get; }

Property Value

Color

CoordinateScope

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

public CoordianteScope CoordinateScope { get; }

Property Value

CoordianteScope

CornerRadius

角丸の半径

public float CornerRadius { get; set; }

Property Value

float

CurrentCoordinate

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

public float2x3 CurrentCoordinate { get; set; }

Property Value

float2x3

CurrentFrame

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

public int CurrentFrame { get; }

Property Value

int

CurrentStyle

現在のスタイル

public GcStyle CurrentStyle { get; set; }

Property Value

GcStyle

CurrentTime

現在フレームの日時

public DateTimeOffset CurrentTime { get; }

Property Value

DateTimeOffset

CurrentTimeDay

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

public int CurrentTimeDay { get; }

Property Value

int

CurrentTimeDayOfWeek

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

public DayOfWeek CurrentTimeDayOfWeek { get; }

Property Value

DayOfWeek

CurrentTimeHour

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

public int CurrentTimeHour { get; }

Property Value

int

CurrentTimeMillisecond

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

public int CurrentTimeMillisecond { get; }

Property Value

int

CurrentTimeMinute

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

public int CurrentTimeMinute { get; }

Property Value

int

CurrentTimeMonth

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

public int CurrentTimeMonth { get; }

Property Value

int

CurrentTimeSecond

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

public int CurrentTimeSecond { get; }

Property Value

int

CurrentTimeYear

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

public int CurrentTimeYear { get; }

Property Value

int

CurrentTimestamp

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

public long CurrentTimestamp { get; }

Property Value

long

DeviceScreenHeight

端末スクリーンの縦幅

public int DeviceScreenHeight { get; }

Property Value

int

DeviceScreenSize

端末スクリーン解像度

public int2 DeviceScreenSize { get; }

Property Value

int2

DeviceScreenWidth

端末スクリーンの横幅

public int DeviceScreenWidth { get; }

Property Value

int

DidUpdateAccelerationThisFrame

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

public bool DidUpdateAccelerationThisFrame { get; }

Property Value

bool

DidUpdateGeolocationThisFrame

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

public bool DidUpdateGeolocationThisFrame { get; }

Property Value

bool

Font

フォント種別

public GcFont Font { get; set; }

Property Value

GcFont

FontSize

フォントサイズ

public int FontSize { get; set; }

Property Value

int

HasUserAuthorizedPermissionCamera

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

public bool HasUserAuthorizedPermissionCamera { get; }

Property Value

bool

HasUserAuthorizedPermissionGeolocation

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

public bool HasUserAuthorizedPermissionGeolocation { get; }

Property Value

bool

IsAccelerometerEnabled

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

public bool IsAccelerometerEnabled { get; set; }

Property Value

bool

IsAccelerometerSupported

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

public bool IsAccelerometerSupported { get; }

Property Value

bool

IsAnyKey

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

public bool IsAnyKey { get; }

Property Value

bool

IsAnyKeyDown

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

public bool IsAnyKeyDown { get; }

Property Value

bool

IsAnyKeyHold

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

public bool IsAnyKeyHold { get; }

Property Value

bool

IsAnyKeyPress

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

public bool IsAnyKeyPress { get; }

Property Value

bool

IsAnyKeyUp

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

public bool IsAnyKeyUp { get; }

Property Value

bool

IsGeolocationRunning

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

public bool IsGeolocationRunning { get; }

Property Value

bool

IsScreenKeyboardSupported

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

public bool IsScreenKeyboardSupported { get; }

Property Value

bool

IsScreenKeyboardVisible

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

public bool IsScreenKeyboardVisible { get; }

Property Value

bool

IsTouchPressureSupported

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

public bool IsTouchPressureSupported { get; }

Property Value

bool

IsTouchSupported

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

public bool IsTouchSupported { get; }

Property Value

bool

Remarks

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

KeyDownCount

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

public int KeyDownCount { get; }

Property Value

int

KeyEscape

戻るボタン（Androidのみ）

public Key KeyEscape { get; }

Property Value

Key

KeyHoldCount

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

public int KeyHoldCount { get; }

Property Value

int

KeyPressCount

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

public int KeyPressCount { get; }

Property Value

int

KeyUpCount

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

public int KeyUpCount { get; }

Property Value

int

LastAccelerationEvent

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

public GcAccelerationEvent LastAccelerationEvent { get; }

Property Value

GcAccelerationEvent

LastGeolocationEvent

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

public GcGeolocationEvent LastGeolocationEvent { get; }

Property Value

GcGeolocationEvent

LastPointerEvent

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

public GcPointerEvent LastPointerEvent { get; }

Property Value

GcPointerEvent

LastPointerFrame

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

public int LastPointerFrame { get; }

Property Value

int

LastPointerPoint

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

public float2 LastPointerPoint { get; }

Property Value

float2

LastPointerTime

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

public float LastPointerTime { get; }

Property Value

float

LastPointerX

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

public float LastPointerX { get; }

Property Value

float

LastPointerY

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

public float LastPointerY { get; }

Property Value

float

LineCap

描線の端点の形状

public GcLineCap LineCap { get; set; }

Property Value

GcLineCap

LineWidth

描線の太さ

public float LineWidth { get; set; }

Property Value

float

NowTime

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

public DateTimeOffset NowTime { get; }

Property Value

DateTimeOffset

PointerBeginCount

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

public int PointerBeginCount { get; }

Property Value

int

PointerCount

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

public int PointerCount { get; }

Property Value

int

PointerEndCount

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

public int PointerEndCount { get; }

Property Value

int

PointerTapCount

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

public int PointerTapCount { get; }

Property Value

int

RectAnchor

矩形のアンカー位置

public GcAnchor RectAnchor { get; set; }

Property Value

GcAnchor

StringAnchor

文字列のアンカー位置

public GcAnchor StringAnchor { get; set; }

Property Value

GcAnchor

StyleScope

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

public StyleScope StyleScope { get; }

Property Value

StyleScope

TapSettings

タップ感度の設定

public GcTapSettings TapSettings { get; set; }

Property Value

GcTapSettings

TargetFrameInterval

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

public double TargetFrameInterval { get; }

Property Value

double

TargetFrameRate

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

public int TargetFrameRate { get; }

Property Value

int

TimeSincePrevFrame

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

public float TimeSincePrevFrame { get; }

Property Value

float

TimeSinceStartup

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

public float TimeSinceStartup { get; }

Property Value

float

VSyncEnabled

垂直同期の有無

public bool VSyncEnabled { get; }

Property Value

bool

Remarks

この設定は、SetFrameInterval(in double, bool) や SetFrameRate(in int, bool) の第二引数から変更できます。

Methods

Abs(in int)

絶対値を計算します

public int Abs(in int value)

Parameters

value int

入力値

Returns

int

絶対値

Abs(in float)

絶対値を計算します

public float Abs(in float value)

Parameters

value float

入力値

Returns

float

絶対値

AddActor(in GcActor)

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

public void AddActor(in GcActor actor)

Parameters

actor GcActor

登録するアクター

AlmostSame(in float, in float)

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

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

Parameters

a float
b float

Returns

bool

同値かどうか

AlmostZero(in float)

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

public bool AlmostZero(in float value)

Parameters

value float

入力値

Returns

bool

ゼロかどうか

Atan2(in float, in float)

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

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

Parameters

x float

ベクトルのX軸の大きさ

y float

ベクトルのY軸の大きさ

Returns

float

角度（度数法）

Atan2(in float2)

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

public float Atan2(in float2 v)

Parameters

v float2

ベクトル

Returns

float

角度（度数法）

CalcStringHeight(in string)

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

public float CalcStringHeight(in string str)

Parameters

str string

文字列

Returns

float

縦幅

CalcStringSize(in string)

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

public float2 CalcStringSize(in string str)

Parameters

str string

文字列

Returns

float2

サイズ

CalcStringWidth(in string)

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

public float CalcStringWidth(in string str)

Parameters

str string

文字列

Returns

float

横幅

CanvasToScreenPoint(in float2, out float2)

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

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

Parameters

canvas float2

変換元 キャンバス座標

screen float2

変換後 端末スクリーン座標

CanvasToScreenPoint(in float2, out int2)

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

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

Parameters

canvas float2

変換元 キャンバス座標

screen int2

変換後 端末スクリーン座標

ChangeBorderColor(in float, in float, in float)

帯の色を変更します

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

Parameters

r float

帯の色の赤成分

g float

帯の色の緑成分

b float

帯の色の青成分

ChangeBorderColor(in Color)

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

public void ChangeBorderColor(in Color color)

Parameters

color Color

新しい帯の色

Remarks

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

ChangeCanvasSize(in int, in int)

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

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

Parameters

width int

横幅

height int

縦幅

Remarks

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

ChangeCanvasSize(in int2)

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

public void ChangeCanvasSize(in int2 size)

Parameters

size int2

新しいキャンバス解像度

Remarks

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

ChangeScene<T>(object?)

シーンを切り替えます

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

Parameters

state object

シーンの開始処理 (EnterScene(object)) に引数として渡す任意の値

Type Parameters

T

開始するシーンの型

Remarks

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

Clamp(in float, in float, in float)

値を丸めます

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

Parameters

value float

入力値

min float

最小値

max float

最大値

Returns

float

ClearCoordinate()

CurrentCoordinate をリセットします

public void ClearCoordinate()

ClearDownloadCache(in string)

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

public void ClearDownloadCache(in string url)

Parameters

url string

リソースURL

ClearDownloadCacheAll()

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

public void ClearDownloadCacheAll()

ClearScreen()

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

public void ClearScreen()

ClearSound()

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

public void ClearSound()

ClearStyle()

CurrentStyle をリセットします

public void ClearStyle()

Cos(in float)

コサインを計算します

public float Cos(in float degree)

Parameters

degree float

角度（度数法）

Returns

float

コサイン

CreateActor<T>()

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

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

Returns

T

登録したアクター

Type Parameters

T

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

Cross(in float2, in float2)

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

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

Parameters

a float2
b float2

Returns

float

外積

CrossTest(in GcLine, in GcLine)

GcLine と GcLine の交差判定

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

Parameters

a GcLine
b GcLine

Returns

bool

CrossTest(in GcLine, in GcLine, out float2)

GcLine と GcLine の交差判定

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

Parameters

a GcLine
b GcLine
intersection float2

Returns

bool

DidUpdateCameraImageThisFrame(in GcCameraDevice)

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

public bool DidUpdateCameraImageThisFrame(in GcCameraDevice camera)

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

Returns

bool

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

Dot(in float2, in float2)

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

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

Parameters

a float2
b float2

Returns

float

内積

DrawCameraImage(in GcCameraDevice, in GcRect, bool)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

rect GcRect

映像をフィッティングする矩形領域

autoPlay bool

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

DrawCameraImage(in GcCameraDevice, bool)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

autoPlay bool

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

DrawCameraImage(in GcCameraDevice, in float, in float, float, bool)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

x float

X座標

y float

Y座標

degree float

回転（度数法）

autoPlay bool

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

DrawCameraImage(in GcCameraDevice, in float, in float, in float, in float, float, bool)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

x float

X座標

y float

Y座標

width float

横幅。映像の横幅がこれになるように拡縮される

height float

縦幅。映像の縦幅がこれになるように拡縮される

degree float

回転（度数法）

autoPlay bool

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

DrawCameraImage(in GcCameraDevice, in float2, float, bool)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

position float2

位置

degree float

回転（度数法）

autoPlay bool

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

DrawCircle()

中抜きの円を描画します

public void DrawCircle()

DrawCircle(in GcCircle)

中抜きの円を描画します

public void DrawCircle(in GcCircle circle)

Parameters

circle GcCircle

円

DrawCircle(in float, in float, in float)

円を線で描画します

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

Parameters

x float

中心のX座標

y float

中心のY座標

radius float

半径

DrawCircle(in float2, in float)

円を線で描画します

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

Parameters

position float2

中心の座標

radius float

半径

DrawImage(in GcImage)

画像を描画します

public void DrawImage(in GcImage image)

Parameters

image GcImage

描画する画像

DrawImage(in GcImage, in GcRect)

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

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

Parameters

image GcImage

描画する画像

rect GcRect

画像をフィッティングする矩形領域

DrawImage(in GcImage, in float, in float, float)

画像を描画します

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

Parameters

image GcImage

描画する画像

x float

X座標

y float

Y座標

degree float

回転（度数法）

DrawImage(in GcImage, in float, in float, in float, in float, float)

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

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

Parameters

image GcImage

描画する画像

x float

X座標

y float

Y座標

width float

横幅。画像の横幅がこれになるように拡縮される

height float

縦幅。画像の縦幅がこれになるように拡縮される

degree float

回転（度数法）

DrawImage(in GcImage, in float2, float)

画像を描画します

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

Parameters

image GcImage

描画する画像

position float2

位置

degree float

回転（度数法）

DrawLine()

線を描画します

public void DrawLine()

DrawLine(in GcLine)

線を描画します

public void DrawLine(in GcLine line)

Parameters

line GcLine

線

DrawLine(in float, in float, in float, in float)

線を描画します

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

Parameters

x0 float

始点のX座標

y0 float

始点のY座標

x1 float

終点のX座標

y1 float

終点のY座標

DrawLine(in float2, in float2)

線を描画します

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

Parameters

begin float2

始点

end float2

終点

DrawOnlineImage(in string)

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

public GcAvailability DrawOnlineImage(in string url)

Parameters

url string

リソースURL

Returns

GcAvailability

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

DrawOnlineImage(in string, in GcRect)

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

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

Parameters

url string

リソースURL

rect GcRect

画像をフィッティングする矩形領域

Returns

GcAvailability

DrawOnlineImage(in string, in float, in float, float)

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

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

Parameters

url string

リソースURL

x float

X座標

y float

Y座標

degree float

回転（度数法）

Returns

GcAvailability

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

DrawOnlineImage(in string, in float, in float, in float, in float, float)

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

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

Parameters

url string

リソースURL

x float

X座標

y float

Y座標

width float

横幅。画像の横幅がこれになるように拡縮される

height float

縦幅。画像の縦幅がこれになるように拡縮される

degree float

回転（度数法）

Returns

GcAvailability

DrawOnlineImage(in string, in float2, float)

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

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

Parameters

url string

リソースURL

position float2

位置

degree float

回転（度数法）

Returns

GcAvailability

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

DrawRect()

矩形を線で描画します

public void DrawRect()

DrawRect(in GcRect)

矩形を線で描画します

public void DrawRect(in GcRect rect)

Parameters

rect GcRect

矩形

DrawRect(in float, in float, in float, in float, float)

矩形を線で描画します

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

Parameters

x float

X座標

y float

Y座標

width float

横幅

height float

縦幅

degree float

回転（度数法）

DrawRect(in float2, in float2, float)

矩形を線で描画します

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

Parameters

position float2

位置

size float2

大きさ

degree float

回転（度数法）

DrawRoundedRect()

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

public void DrawRoundedRect()

DrawRoundedRect(in GcRect)

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

public void DrawRoundedRect(in GcRect rect)

Parameters

rect GcRect

二等辺三角形が収まる矩形

DrawRoundedRect(in GcRect, float)

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

public void DrawRoundedRect(in GcRect rect, float cornerRect)

Parameters

rect GcRect

二等辺三角形が収まる矩形

cornerRect float

DrawRoundedRect(in float, in float, in float, in float, float)

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

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

Parameters

x float

X座標

y float

Y座標

width float

横幅

height float

縦幅

degree float

回転（度数法）

DrawRoundedRect(in float, in float, in float, in float, float, float)

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

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

Parameters

x float

X座標

y float

Y座標

width float

横幅

height float

縦幅

cornerRadius float

角丸の半径

degree float

回転（度数法）

DrawRoundedRect(in float2, in float2, float)

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

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

Parameters

position float2

位置

size float2

大きさ

degree float

回転（度数法）

DrawRoundedRect(in float2, in float2, float, float)

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

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

Parameters

position float2

位置

size float2

大きさ

cornerRadius float

角丸の半径

degree float

回転（度数法）

DrawString(in string)

文字列を描画します

public void DrawString(in string str)

Parameters

str string

描画する文字列

DrawString(in string, in GcRect)

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

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

Parameters

str string

描画する文字列

rect GcRect

文字列をフィッティングする矩形領域

DrawString(in string, in float, in float, float)

文字列を描画します

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

Parameters

str string

描画する文字列

x float

X座標

y float

Y座標

degree float

回転（度数法）

DrawString(in string, in float, in float, in float, in float, float)

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

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

Parameters

str string

描画する文字列

x float

X座標

y float

Y座標

width float

横幅。文字列の横幅がこれになるように拡縮される

height float

縦幅。文字列の縦幅がこれになるように拡縮される

degree float

回転（度数法）

DrawString(in string, in float2, float)

文字列を描画します

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

Parameters

str string

描画する文字列

position float2

位置

degree float

回転（度数法）

DrawTexture(in Texture)

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

public void DrawTexture(in Texture texture)

Parameters

texture Texture

描画するテクスチャー

DrawTexture(in Texture, in GcRect)

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

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

Parameters

texture Texture

描画するテクスチャー

rect GcRect

テクスチャーをフィッティングする矩形領域

DrawTexture(in Texture, in float, in float, in float, in float, float)

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

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

Parameters

texture Texture

描画するテクスチャー

x float

X座標

y float

Y座標

width float

横幅。画像の横幅がこれになるように拡縮される

height float

縦幅。画像の縦幅がこれになるように拡縮される

degree float

回転（度数法）

DrawTexture(in Texture, in float2, float)

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

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

Parameters

texture Texture

描画するテクスチャー

position float2

位置

degree float

回転（度数法）

DrawTexture(in Texture, in float2x3)

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

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

Parameters

texture Texture

描画するテクスチャー

matrix float2x3

アフィン変換行列

EraseSavedDataAll()

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

public void EraseSavedDataAll()

FillCircle()

円を塗りで描画します

public void FillCircle()

FillCircle(in GcCircle)

円を塗りで描画します

public void FillCircle(in GcCircle circle)

Parameters

circle GcCircle

円

FillCircle(in float, in float, in float)

円を塗りで描画します

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

Parameters

x float

中心のX座標

y float

中心のY座標

radius float

半径

FillCircle(in float2, in float)

円を塗りで描画します

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

Parameters

position float2

中心の座標

radius float

半径

FillRect()

矩形を塗りで描画します

public void FillRect()

FillRect(in GcRect)

矩形を塗りで描画します

public void FillRect(in GcRect rect)

Parameters

rect GcRect

矩形

FillRect(in float, in float, in float, in float, float)

矩形を塗りで描画します

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

Parameters

x float

X座標

y float

Y座標

width float

横幅

height float

縦幅

degree float

回転（度数法）

FillRect(in float2, in float2, float)

矩形を塗りで描画します

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

Parameters

position float2

位置

size float2

大きさ

degree float

回転（度数法）

FillRoundedRect()

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

public void FillRoundedRect()

FillRoundedRect(in GcRect)

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

public void FillRoundedRect(in GcRect rect)

Parameters

rect GcRect

二等辺三角形が収まる矩形

FillRoundedRect(in GcRect, float)

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

public void FillRoundedRect(in GcRect rect, float cornerRadius)

Parameters

rect GcRect

二等辺三角形が収まる矩形

cornerRadius float

角丸の半径

FillRoundedRect(in float, in float, in float, in float, float)

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

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

Parameters

x float

X座標

y float

Y座標

width float

横幅

height float

縦幅

degree float

回転（度数法）

FillRoundedRect(in float, in float, in float, in float, float, float)

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

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

Parameters

x float

X座標

y float

Y座標

width float

横幅

height float

縦幅

cornerRadius float

角丸の半径

degree float

回転（度数法）

FillRoundedRect(in float2, in float2, float)

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

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

Parameters

position float2

位置

size float2

大きさ

degree float

回転（度数法）

FillRoundedRect(in float2, in float2, float, float)

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

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

Parameters

position float2

位置

size float2

大きさ

cornerRadius float

角丸の半径

degree float

回転（度数法）

FocusCameraImage(in GcCameraDevice, in float2?)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

uv float2?

焦点をあわせる位置（左下を原点とする 0.0～1.0 のUV座標系）

Remarks

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

GetActor()

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

public GcActor? GetActor()

Returns

GcActor

取得できたアクター

GetActorCount()

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

public int GetActorCount()

Returns

int

アクターの数

GetActorCount<T>()

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

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

Returns

int

アクターの数

Type Parameters

T

取得するアクターの型

GetActor<T>()

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

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

Returns

T

取得できたアクター

Type Parameters

T

取得するアクターの型

GetImageHeight(in GcImage)

画像の縦幅を取得します

public int GetImageHeight(in GcImage image)

Parameters

image GcImage

画像

Returns

int

縦幅

GetImageSize(in GcImage)

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

public int2 GetImageSize(in GcImage image)

Parameters

image GcImage

画像

Returns

int2

サイズ

GetImageWidth(in GcImage)

画像の横幅を取得します

public int GetImageWidth(in GcImage image)

Parameters

image GcImage

画像

Returns

int

横幅

GetKeyPressDuration(in Key)

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

public float GetKeyPressDuration(in Key key)

Parameters

key Key

キー

Returns

float

時間（秒）

GetKeyPressFrameCount(in Key)

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

public int GetKeyPressFrameCount(in Key key)

Parameters

key Key

キー

Returns

int

フレーム数

GetOnlineImageHeight(in string)

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

public int GetOnlineImageHeight(in string url)

Parameters

url string

リソースURL

Returns

int

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

GetOnlineImageWidth(in string)

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

public int GetOnlineImageWidth(in string url)

Parameters

url string

リソースURL

Returns

int

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

GetOrCreateCameraTexture(in GcCameraDevice, in GcResolution)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

request GcResolution

テクスチャーが未生成だった場合に、希望する解像度とリフレッシュレート

Returns

WebCamTexture

テクスチャー

Remarks

GetPrimaryCameraResolution(in GcCameraDevice)

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

public GcResolution GetPrimaryCameraResolution(in GcCameraDevice camera)

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

Returns

GcResolution

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

Remarks

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

GetRandomState()

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

public uint GetRandomState()

Returns

uint

シード値

GetSoundLevel(GcSoundTrack)

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

public float GetSoundLevel(GcSoundTrack track = GcSoundTrack.Master)

Parameters

track GcSoundTrack

対象の音声トラック

Returns

float

音量（-96db～20db）

GetSoundVolume(GcSoundTrack)

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

public float GetSoundVolume(GcSoundTrack track = GcSoundTrack.Master)

Parameters

track GcSoundTrack

対象の音声トラック

Returns

float

音量（0f～1f）

HideScreenKeyboard()

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

public void HideScreenKeyboard()

HitTest(in GcAABB, in GcAABB)

GcAABB と GcAABB の接触判定

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

Parameters

a GcAABB
b GcAABB

Returns

bool

HitTest(in GcAABB, in float2)

GcAABB と 点の接触判定

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

Parameters

aabb GcAABB
point float2

Returns

bool

HitTest(in GcCircle, in GcCircle)

GcCircle と GcCircle の接触判定

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

Parameters

circle1 GcCircle
circle2 GcCircle

Returns

bool

HitTest(in GcCircle, in float2)

GcCircle と 点の接触判定

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

Parameters

circle GcCircle
point float2

Returns

bool

IsFlippedCameraImage(in GcCameraDevice)

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

public bool IsFlippedCameraImage(in GcCameraDevice camera)

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

Returns

bool

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

IsKeyDown(in Key)

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

public bool IsKeyDown(in Key key)

Parameters

key Key

キー

Returns

bool

押されたかどうか

IsKeyHold(in Key)

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

public bool IsKeyHold(in Key key)

Parameters

key Key

キー

Returns

bool

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

IsKeyHold(in Key, out GcKeyTrace)

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

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

Parameters

key Key

キー

trace GcKeyTrace

キーの軌跡

Returns

bool

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

IsKeyPress(in Key)

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

public bool IsKeyPress(in Key key)

Parameters

key Key

キー

Returns

bool

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

IsKeyUp(in Key)

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

public bool IsKeyUp(in Key key)

Parameters

key Key

キー

Returns

bool

離されたかどうか

IsKeyUp(in Key, out GcKeyTrace)

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

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

Parameters

key Key

キー

trace GcKeyTrace

キーの軌跡

Returns

bool

離されたかどうか

IsPlayingCameraImage(in GcCameraDevice)

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

public bool IsPlayingCameraImage(in GcCameraDevice camera)

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

Returns

bool

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

IsPlayingSound(GcSoundTrack)

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

public bool IsPlayingSound(GcSoundTrack track = GcSoundTrack.BGM1)

Parameters

track GcSoundTrack

対象の音声トラック

Returns

bool

再生中かどうか

IsTapped()

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

public bool IsTapped()

Returns

bool

タップされたかどうか

IsTapped(in GcAABB, out float2)

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

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

Parameters

aabb GcAABB

領域

point float2

タップ位置

Returns

bool

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

IsTapped(out float, out float)

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

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

Parameters

x float

タップ位置 X座標

y float

タップ位置 Y座標

Returns

bool

タップされたかどうか

IsTapped(in float, in float, in float, in float, out float, out float)

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

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

Parameters

x float

領域 左上X座標

y float

領域 左上Y座標

width float

領域 横幅

height float

領域 縦幅

px float

タップ位置 X座標

py float

タップ位置 Y座標

Returns

bool

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

IsTapped(out float2)

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

public bool IsTapped(out float2 point)

Parameters

point float2

タップ位置

Returns

bool

タップされたかどうか

IsTouchBegan()

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

public bool IsTouchBegan()

Returns

bool

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

IsTouchBegan(in GcAABB, out float2)

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

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

Parameters

aabb GcAABB

領域

point float2

タッチ位置

Returns

bool

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

IsTouchBegan(out GcPointerEvent)

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

public bool IsTouchBegan(out GcPointerEvent pointer)

Parameters

pointer GcPointerEvent

ポインターイベント

Returns

bool

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

IsTouchBegan(out float, out float)

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

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

Parameters

x float

タッチ位置 X座標

y float

タッチ位置 Y座標

Returns

bool

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

IsTouchBegan(in float, in float, in float, in float, out float, out float)

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

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

Parameters

x float

領域 左上X座標

y float

領域 左上Y座標

width float

領域 横幅

height float

領域 縦幅

px float

タッチ位置 X座標

py float

タッチ位置 Y座標

Returns

bool

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

IsTouchBegan(out float2)

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

public bool IsTouchBegan(out float2 point)

Parameters

point float2

タッチ位置

Returns

bool

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

IsTouchEnded()

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

public bool IsTouchEnded()

Returns

bool

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

IsTouchEnded(in GcAABB, out float2)

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

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

Parameters

aabb GcAABB

領域

point float2

タッチ位置

Returns

bool

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

IsTouchEnded(out GcPointerEvent)

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

public bool IsTouchEnded(out GcPointerEvent pointer)

Parameters

pointer GcPointerEvent

ポインターイベント

Returns

bool

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

IsTouchEnded(out GcPointerTrace)

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

public bool IsTouchEnded(out GcPointerTrace pointer)

Parameters

pointer GcPointerTrace

タッチの軌跡

Returns

bool

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

IsTouchEnded(out float, out float)

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

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

Parameters

x float

タッチ位置 X座標

y float

タッチ位置 Y座標

Returns

bool

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

IsTouchEnded(in float, in float, in float, in float, out float, out float)

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

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

Parameters

x float

領域 左上X座標

y float

領域 左上Y座標

width float

領域 横幅

height float

領域 縦幅

px float

タッチ位置 X座標

py float

タッチ位置 Y座標

Returns

bool

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

IsTouchEnded(out float2)

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

public bool IsTouchEnded(out float2 point)

Parameters

point float2

タッチ位置

Returns

bool

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

IsTouched()

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

public bool IsTouched()

Returns

bool

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

IsTouched(in GcAABB, out float2)

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

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

Parameters

aabb GcAABB

領域

point float2

タッチ位置

Returns

bool

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

IsTouched(out GcPointerEvent)

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

public bool IsTouched(out GcPointerEvent pointer)

Parameters

pointer GcPointerEvent

Returns

bool

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

IsTouched(out GcPointerTrace)

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

public bool IsTouched(out GcPointerTrace pointer)

Parameters

pointer GcPointerTrace

Returns

bool

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

IsTouched(out float, out float)

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

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

Parameters

x float

タッチ位置 X座標

y float

タッチ位置 Y座標

Returns

bool

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

IsTouched(in float, in float, in float, in float, out float, out float)

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

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

Parameters

x float

領域 左上X座標

y float

領域 左上Y座標

width float

領域 横幅

height float

領域 縦幅

px float

タッチ位置 X座標

py float

タッチ位置 Y座標

Returns

bool

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

IsTouched(out float2)

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

public bool IsTouched(out float2 point)

Parameters

point float2

タッチ位置

Returns

bool

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

Max(in float, in float)

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

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

Parameters

a float
b float

Returns

float

大きい方の値

Min(in float, in float)

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

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

Parameters

a float
b float

Returns

float

小さい方の値

PauseCameraImage(in GcCameraDevice)

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

public bool PauseCameraImage(in GcCameraDevice camera)

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

Returns

bool

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

PauseSound(GcSoundTrack)

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

public void PauseSound(GcSoundTrack track = GcSoundTrack.BGM1)

Parameters

track GcSoundTrack

対象の音声トラック

Remarks

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

PlayCameraImage(in GcCameraDevice)

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

public bool PlayCameraImage(in GcCameraDevice camera)

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

Returns

bool

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

Remarks

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

PlayCameraImage(in GcCameraDevice, in GcResolution, out int2)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

request GcResolution

テクスチャーが未生成だった場合に、希望する解像度とリフレッシュレート

resolution int2

カメラ（外部入力映像）の解像度

Returns

bool

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

Remarks

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

PlayCameraImage(in GcCameraDevice, out int2)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

resolution int2

カメラ（外部入力映像）の解像度

Returns

bool

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

Remarks

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

PlaySE(in GcSound)

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

public void PlaySE(in GcSound sound)

Parameters

sound GcSound

サウンド

PlaySE(in AudioClip)

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

public void PlaySE(in AudioClip clip)

Parameters

clip AudioClip

サウンド

PlaySound(in GcSound, GcSoundTrack, bool)

サウンドを再生します

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

Parameters

sound GcSound
track GcSoundTrack

対象の音声トラック

loop bool

ループ再生するかどうか（SEトラック以外）

PlaySound(in AudioClip, GcSoundTrack, bool)

サウンドを再生します

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

Parameters

clip AudioClip

サウンド

track GcSoundTrack

対象の音声トラック

loop bool

ループ再生するかどうか（SEトラック以外）

PopCoordinate()

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

public void PopCoordinate()

PopStyle()

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

public void PopStyle()

PushCoordinate()

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

public void PushCoordinate()

PushStyle()

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

public void PushStyle()

Random()

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

public float Random()

Returns

float

ランダムな値

Random(in int, in int)

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

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

Parameters

min int

最小値

max int

最大値

Returns

int

ランダムな値

Random(in float, in float)

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

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

Parameters

min float

最小値

max float

最大値

Returns

float

ランダムな値

RebuildFontTexture()

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

public void RebuildFontTexture()

Remarks

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

RegisterScene(in GcScene)

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

public void RegisterScene(in GcScene scene)

Parameters

scene GcScene

登録するシーン

Remarks

登録したシーンは ChangeScene<T>(object?) を呼び出すことで有効になります

RegisterScene<T>()

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

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

Type Parameters

T

登録するシーンの型

Remarks

登録したシーンは ChangeScene<T>(object?) を呼び出すことで有効になります

RemoveActorAll()

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

public void RemoveActorAll()

Repeat(in float, in float)

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

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

Parameters

value float

入力値

max float

最大値

Returns

float

RequestUserAuthorizedPermissionCameraAsync(in Action<bool>)

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

public void RequestUserAuthorizedPermissionCameraAsync(in Action<bool> callback)

Parameters

callback Action<bool>

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

RequestUserAuthorizedPermissionGeolocationAsync(in Action<bool>)

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

public void RequestUserAuthorizedPermissionGeolocationAsync(in Action<bool> callback)

Parameters

callback Action<bool>

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

RotateCoordinate(in float)

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

public void RotateCoordinate(in float degree)

Parameters

degree float

回転量（度数法）

RotateCoordinate(in float, in float, in float)

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

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

Parameters

degree float

回転量（度数法）

originX float

回転中心のX座標

originY float

回転中心のY座標

RotateCoordinate(in float, in float2)

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

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

Parameters

degree float

回転量（度数法）

origin float2

回転中心

RotateVector(in float2, in float)

ベクトルを回転します

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

Parameters

vector float2

ベクトル

degree float

回転量（度数法）

Returns

float2

回転後のベクトル

Round(in double)

値を四捨五入します

public int Round(in double value)

Parameters

value double

入力値

Returns

int

四捨五入された値

Round(in float)

値を四捨五入します

public int Round(in float value)

Parameters

value float

入力値

Returns

int

四捨五入された値

Save(in string, int?)

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

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

Parameters

key string

キー

value int?

保存する値

Remarks

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

Save(in string, float?)

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

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

Parameters

key string

キー

value float?

保存する値

Remarks

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

Save(in string, string?)

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

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

Parameters

key string

キー

value string

保存する値

Remarks

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

SaveScreenshotAsync(Action<string?>?)

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

public void SaveScreenshotAsync(Action<string?>? onComplete = null)

Parameters

onComplete Action<string>

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

Remarks

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

ScaleCoordinate(in float, in float)

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

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

Parameters

sx float

X軸方向の拡縮率

sy float

Y軸方向の拡縮率

ScaleCoordinate(in float2)

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

public void ScaleCoordinate(in float2 scaling)

Parameters

scaling float2

拡縮率

ScreenToCanvasPoint(in float2, out float2)

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

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

Parameters

screen float2

変換元 端末スクリーン座標

canvas float2

変換後 キャンバス座標

ScreenToCanvasPoint(in float2, out int2)

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

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

Parameters

screen float2

変換元 端末スクリーン座標

canvas int2

変換後 キャンバス座標

SetBackgroundColor(in float, in float, in float)

背景色を指定します

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

Parameters

r float

背景色の赤成分

g float

背景色の緑成分

b float

背景色の青成分

SetBackgroundColor(in Color)

背景色を指定します

public void SetBackgroundColor(in Color color)

Parameters

color Color

背景色

SetColor(in byte, in byte, in byte, byte)

描画色を指定します

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

Parameters

r byte

描画色の赤成分

g byte

描画色の緑成分

b byte

描画色の青成分

a byte

描画色の不透明度

SetColor(in float, in float, in float, float)

描画色を指定します

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

Parameters

r float

描画色の赤成分

g float

描画色の緑成分

b float

描画色の青成分

a float

描画色の不透明度

SetColor(in Color)

描画色を指定します

public void SetColor(in Color color)

Parameters

color Color

描画色

SetColor(in Color, in float)

描画色を指定します

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

Parameters

color Color

描画色

alpha float

描画色の不透明度

SetCoordinate(in float2x3)

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

public void SetCoordinate(in float2x3 matrix)

Parameters

matrix float2x3

座標系（変換行列）

SetFont(in GcFont)

フォントを指定します

public void SetFont(in GcFont font)

Parameters

font GcFont

フォント

SetFontSize(in int)

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

public void SetFontSize(in int fontSize)

Parameters

fontSize int

フォントサイズ

SetFrameInterval(in double, bool)

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

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

Parameters

targetDeltaTime double

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

vSyncEnabled bool

垂直同期の有無

Remarks

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

SetFrameRate(in int, bool)

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

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

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

Parameters

targetFrameRate int

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

vSyncEnabled bool

垂直同期の有無

Remarks

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

SetLineCap(in GcLineCap)

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

public void SetLineCap(in GcLineCap lineCap)

Parameters

lineCap GcLineCap

描線の端点の形状

SetLineWidth(in float)

描線の太さを指定します

public void SetLineWidth(in float lineWidth)

Parameters

lineWidth float

描線の太さ

SetRandomSeed(in uint)

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

public void SetRandomSeed(in uint seed)

Parameters

seed uint

シード値

SetRandomSeedByIndex(in uint)

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

public void SetRandomSeedByIndex(in uint index)

Parameters

index uint

インデックス

SetRectAnchor(in GcAnchor)

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

public void SetRectAnchor(in GcAnchor anchor)

Parameters

anchor GcAnchor

アンカー位置

SetSoundLevel(in float, GcSoundTrack)

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

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

Parameters

decibel float

音量（-96db～20db）

track GcSoundTrack

対象の音声トラック

SetSoundVolume(in float, GcSoundTrack)

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

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

Parameters

volume float

音量（0f～1f）

track GcSoundTrack

対象の音声トラック

SetStringAnchor(in GcAnchor)

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

public void SetStringAnchor(in GcAnchor anchor)

Parameters

anchor GcAnchor

アンカー位置

SetStyle(in GcStyle)

スタイルを指定します

public void SetStyle(in GcStyle style)

Parameters

style GcStyle

ShowScreenKeyboard()

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

public bool ShowScreenKeyboard()

Returns

bool

表示できたかどうか

Sin(in float)

サインを計算します

public float Sin(in float degree)

Parameters

degree float

角度（度数法）

Returns

float

サイン

Sqrt(in float)

平方根を計算します

public float Sqrt(in float value)

Parameters

value float

入力値

Returns

float

平方根

StartGeolocationService(float, float)

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

public void StartGeolocationService(float desiredAccuracy = 10, float updateDistance = 10)

Parameters

desiredAccuracy float

望ましいサービス精度（メートル単位）

updateDistance float

位置情報の更新に必要な最小移動距離（メートル単位）

Remarks

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

StopCameraImage(in GcCameraDevice)

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

public void StopCameraImage(in GcCameraDevice camera)

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

StopGeolocationService()

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

public void StopGeolocationService()

StopSound(GcSoundTrack)

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

public void StopSound(GcSoundTrack track = GcSoundTrack.BGM1)

Parameters

track GcSoundTrack

対象の音声トラック

Remarks

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

SweepTest(in GcAABB, in GcAABB, in float2, out GcSweepResult)

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

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

Parameters

static GcAABB
dynamic GcAABB
delta float2
hit GcSweepResult

Returns

bool

SweepTest(in GcAABB, in float2, in float2, out GcSweepResult)

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

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

Parameters

static GcAABB
dynamic float2
delta float2
hit GcSweepResult

Returns

bool

TranslateCoordinate(in float, in float)

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

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

Parameters

tx float

X軸方向の移動量

ty float

Y軸方向の移動量

TranslateCoordinate(in float2)

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

public void TranslateCoordinate(in float2 translation)

Parameters

translation float2

移動量

TryChangeCameraImageResolution(in GcCameraDevice, in GcResolution)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

request GcResolution

希望する解像度とリフレッシュレート

Returns

int2

実際に設定された解像度

TryGetAccelerationEvent(int, out GcAccelerationEvent)

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

public bool TryGetAccelerationEvent(int i, out GcAccelerationEvent e)

Parameters

i int

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

e GcAccelerationEvent

イベント

Returns

bool

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

TryGetAccelerationEventAll(out ReadOnlySpan<GcAccelerationEvent>)

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

public bool TryGetAccelerationEventAll(out ReadOnlySpan<GcAccelerationEvent> events)

Parameters

events ReadOnlySpan<GcAccelerationEvent>

イベント配列

Returns

bool

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

TryGetActor(in int, out GcActor?)

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

public bool TryGetActor(in int i, out GcActor? actor)

Parameters

i int

取得するアクターのインデックス（0以上GetActorCount()未満）

actor GcActor

取得できたアクター

Returns

bool

取得できたかどうか

TryGetActorAll<T>(out ReadOnlySpan<T>)

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

public bool TryGetActorAll<T>(out ReadOnlySpan<T> actors) where T : GcActor

Parameters

actors ReadOnlySpan<T>

取得したアクターの一覧

Returns

bool

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

Type Parameters

T

取得するアクターの型

TryGetActor<T>(in int, out T?)

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

public bool TryGetActor<T>(in int i, out T? actor) where T : GcActor

Parameters

i int

取得するアクターのインデックス（0以上GetActorCount<T>()未満）

actor T

取得できたアクター

Returns

bool

取得できたかどうか

Type Parameters

T

取得するアクターの型

TryGetCameraImage(out GcCameraDevice?)

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

public bool TryGetCameraImage(out GcCameraDevice? camera)

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

Returns

bool

取得できたかどうか

TryGetCameraImage(in string, out GcCameraDevice?)

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

public bool TryGetCameraImage(in string deviceName, out GcCameraDevice? camera)

Parameters

deviceName string

デバイス名

camera GcCameraDevice

カメラ（外部入力映像）

Returns

bool

取得できたかどうか

TryGetCameraImageAll(out ReadOnlySpan<GcCameraDevice>)

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

public bool TryGetCameraImageAll(out ReadOnlySpan<GcCameraDevice> devices)

Parameters

devices ReadOnlySpan<GcCameraDevice>

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

Returns

bool

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

TryGetCameraImageRotation(in GcCameraDevice, out float)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

degree float

回転角度

Returns

bool

取得できたかどうか

TryGetCameraImageSize(in GcCameraDevice, out int2)

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

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

Parameters

camera GcCameraDevice

カメラ（外部入力映像）

resolution int2

カメラ（外部入力映像）の解像度

Returns

bool

取得できたかどうか

Remarks

TryGetGeolocationEvent(out GcGeolocationEvent)

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

public bool TryGetGeolocationEvent(out GcGeolocationEvent data)

Parameters

data GcGeolocationEvent

Returns

bool

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

TryGetKeyEvent(in Key, out GcKeyEvent)

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

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

Parameters

key Key

キー

e GcKeyEvent

キーイベント

Returns

bool

取得できたかどうか

TryGetKeyEventAll(in GcKeyEventPhase, out ReadOnlySpan<GcKeyEvent>)

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

public bool TryGetKeyEventAll(in GcKeyEventPhase phase, out ReadOnlySpan<GcKeyEvent> events)

Parameters

phase GcKeyEventPhase

キーイベント状態

events ReadOnlySpan<GcKeyEvent>

キーイベントの一覧

Returns

bool

要素数が1以上かどうか

TryGetKeyEventAll(out ReadOnlySpan<GcKeyEvent>)

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

public bool TryGetKeyEventAll(out ReadOnlySpan<GcKeyEvent> events)

Parameters

events ReadOnlySpan<GcKeyEvent>

キーイベントの一覧

Returns

bool

要素数が1以上かどうか

TryGetKeyTrace(in Key, out GcKeyTrace)

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

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

Parameters

key Key

キー

trace GcKeyTrace

キーの軌跡

Returns

bool

取得できたかどうか

TryGetKeyTraceAll(in GcKeyEventPhase, out ReadOnlySpan<GcKeyTrace>)

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

public bool TryGetKeyTraceAll(in GcKeyEventPhase phase, out ReadOnlySpan<GcKeyTrace> traces)

Parameters

phase GcKeyEventPhase

キーイベント状態

traces ReadOnlySpan<GcKeyTrace>

キーの軌跡の一覧

Returns

bool

要素数が1以上かどうか

TryGetKeyTraceAll(out ReadOnlySpan<GcKeyTrace>)

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

public bool TryGetKeyTraceAll(out ReadOnlySpan<GcKeyTrace> traces)

Parameters

traces ReadOnlySpan<GcKeyTrace>

キーの軌跡の一覧

Returns

bool

要素数が1以上かどうか

TryGetOnlineImage(in string, out GcAvailability, out Texture2D?)

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

public bool TryGetOnlineImage(in string url, out GcAvailability availability, out Texture2D? texture)

Parameters

url string

リソースURL

availability GcAvailability
texture Texture2D

画像リソース。戻り値がReady以外だとNull

Returns

bool

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

TryGetOnlineImageSize(in string, out int2)

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

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

Parameters

url string

リソースURL

size int2

オンライン画像リソースの寸法

Returns

bool

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

TryGetOnlineSound(in string, out GcAvailability, out AudioClip?)

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

public bool TryGetOnlineSound(in string url, out GcAvailability availability, out AudioClip? clip)

Parameters

url string

リソースURL

availability GcAvailability
clip AudioClip

音声リソース。戻り値がReady以外だとNull

Returns

bool

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

TryGetOnlineSound(in string, in AudioType, out GcAvailability, out AudioClip?)

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

public bool TryGetOnlineSound(in string url, in AudioType type, out GcAvailability availability, out AudioClip? clip)

Parameters

url string

リソースURL

type AudioType

音声リソースの形式

availability GcAvailability
clip AudioClip

音声リソース。戻り値がReady以外だとNull

Returns

bool

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

TryGetOnlineText(in string, out GcAvailability, out string?)

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

public bool TryGetOnlineText(in string url, out GcAvailability availability, out string? str)

Parameters

url string

リソースURL

availability GcAvailability
str string

Returns

bool

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

TryGetPointerEvent(in GcPointerEventPhase, in int, out GcPointerEvent)

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

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

Parameters

phase GcPointerEventPhase

イベント状態

i int

イベントインデックス（イベントIDではない）

e GcPointerEvent

イベント

Returns

bool

取得できたかどうか

TryGetPointerEvent(in int, out GcPointerEvent)

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

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

Parameters

i int

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

e GcPointerEvent

イベント

Returns

bool

取得できたかどうか

TryGetPointerEventAll(in GcPointerEventPhase, out ReadOnlySpan<GcPointerEvent>)

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

public bool TryGetPointerEventAll(in GcPointerEventPhase phase, out ReadOnlySpan<GcPointerEvent> events)

Parameters

phase GcPointerEventPhase

イベント状態

events ReadOnlySpan<GcPointerEvent>

イベントの一覧

Returns

bool

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

TryGetPointerEventAll(out ReadOnlySpan<GcPointerEvent>)

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

public bool TryGetPointerEventAll(out ReadOnlySpan<GcPointerEvent> events)

Parameters

events ReadOnlySpan<GcPointerEvent>

イベントの一覧

Returns

bool

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

TryGetPointerTapPoint(in int, out float2)

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

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

Parameters

i int

タップインデックス

point float2

タップポイント

Returns

bool

取得できたかどうか

TryGetPointerTapPointAll(out ReadOnlySpan<float2>)

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

public bool TryGetPointerTapPointAll(out ReadOnlySpan<float2> points)

Parameters

points ReadOnlySpan<float2>

タップポイントの一覧

Returns

bool

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

TryGetPointerTrace(in GcPointerEventPhase, in int, out GcPointerTrace)

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

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

Parameters

phase GcPointerEventPhase

イベント状態

i int

イベントインデックス（イベントIDではない）

trace GcPointerTrace

軌跡

Returns

bool

取得できたかどうか

Remarks

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

TryGetPointerTrace(in int, out GcPointerTrace)

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

public bool TryGetPointerTrace(in int i, out GcPointerTrace history)

Parameters

i int

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

history GcPointerTrace

Returns

bool

取得できたかどうか

TryGetPointerTraceAll(in GcPointerEventPhase, out ReadOnlySpan<GcPointerTrace>)

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

public bool TryGetPointerTraceAll(in GcPointerEventPhase phase, out ReadOnlySpan<GcPointerTrace> traces)

Parameters

phase GcPointerEventPhase
traces ReadOnlySpan<GcPointerTrace>

軌跡の一覧

Returns

bool

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

Remarks

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

TryGetPointerTraceAll(out ReadOnlySpan<GcPointerTrace>)

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

public bool TryGetPointerTraceAll(out ReadOnlySpan<GcPointerTrace> traces)

Parameters

traces ReadOnlySpan<GcPointerTrace>

軌跡の一覧

Returns

bool

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

TryGetScreenKeyboardArea(out GcAABB)

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

public bool TryGetScreenKeyboardArea(out GcAABB area)

Parameters

area GcAABB

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

Returns

bool

取得できたかどうか

Remarks

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

TryLoad(in string, out int)

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

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

Parameters

key string

キー

value int

取り出した値

Returns

bool

取り出せたかどうか

TryLoad(in string, out float)

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

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

Parameters

key string

キー

value float

取り出した値

Returns

bool

取り出せたかどうか

TryLoad(in string, out string?)

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

public bool TryLoad(in string key, out string? value)

Parameters

key string

キー

value string

取り出した値

Returns

bool

取り出せたかどうか

TryRemoveActor(in GcActor)

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

public bool TryRemoveActor(in GcActor actor)

Parameters

actor GcActor

登録解除するアクター

Returns

bool

登録解除できたかどうか

UnpauseSound(GcSoundTrack)

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

public void UnpauseSound(GcSoundTrack track = GcSoundTrack.BGM1)

Parameters

track GcSoundTrack

対象の音声トラック

Remarks

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

UnregisterScene(in GcScene)

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

public void UnregisterScene(in GcScene scene)

Parameters

scene GcScene

削除するシーン

Remarks

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

UnregisterScene<T>()

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

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

Type Parameters

T

削除するシーンの型

Remarks

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

UpdateCameraDevice()

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

public int UpdateCameraDevice()

Returns

int

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