Functions
Point	Pos () noexcept
	現在のフレームにおける、マウスカーソルのクライアント座標（ピクセル）を返します。 More...

Vec2	PosF () noexcept
	現在のフレームにおける、マウスカーソルのクライアント座標（ピクセル）を返します。 More...

Point	PreviousPos () noexcept
	直前のフレームにおける、マウスカーソルのクライアント座標（ピクセル）を返します。 More...

Vec2	PreviousPosF () noexcept
	直前のフレームにおける、マウスカーソルのクライアント座標（ピクセル）を返します。 More...

Point	Delta () noexcept
	直前のフレームから現在のフレームまでのマウスカーソルの移動量（ピクセル）を返します。 More...

Vec2	DeltaF () noexcept
	直前のフレームから現在のフレームまでのマウスカーソルの移動量（ピクセル）を返します。 More...

Point	PosRaw () noexcept
	現在のフレームにおける、未変換のマウスカーソルのクライアント座標（ピクセル）を返します。 More...

Point	PreviousPosRaw () noexcept
	直前のフレームにおける、未変換のマウスカーソルのクライアント座標（ピクセル）を返します。 More...

Point	DeltaRaw () noexcept
	直前のフレームから現在のフレームまでの未変換のマウスカーソルの移動量（ピクセル）を返します。 More...

Point	ScreenPos () noexcept
	現在のフレームにおける、マウスカーソルのスクリーン座標（ピクセル）を返します。 More...

Point	ScreenPreviousPos () noexcept
	直前のフレームにおける、マウスカーソルのスクリーン座標（ピクセル）を返します。 More...

Point	ScreenDelta () noexcept
	直前のフレームから現在のフレームまでの、スクリーン上でのマウスカーソルの移動量（ピクセル）を返します。 More...

void	SetPos (int32 x, int32 y)
	マウスカーソルを指定したクライアント座標に移動させます。 More...

void	SetPos (Point pos)
	マウスカーソルを指定したクライアント座標に移動させます。 More...

bool	OnClientRect ()
	マウスカーソルがクライアント画面上にあるかを返します。 More...

bool	IsClippedToWindow () noexcept
	マウスカーソルの移動範囲をクライアント画面に制限されているかを返します。 More...

void	ClipToWindow (bool clip)
	マウスカーソルの移動範囲をクライアント画面に制限します More...

void	SetDefaultStyle (CursorStyle style)
	アプリケーションのデフォルトのマウスカーソルを設定します。 More...

void	RequestStyle (CursorStyle style)
	現在のフレームのマウスカーソルを、指定したスタイルにするようリクエストします。 More...

bool	RegisterCustomCursorStyle (StringView name, const Image &image, Point hotSpot=Point{ 0, 0 })
	カスタムのマウスカーソルを登録します。 More...

void	RequestStyle (StringView name)
	現在のフレームのマウスカーソルを、指定したカスタムマウスカーソルにするようリクエストします。 More...

const Mat3x2 &	GetLocalTransform () noexcept
	マウスカーソルのクライアント座標に適用されているローカル座標変換を返します。 More...

const Mat3x2 &	GetCameraTransform () noexcept
	マウスカーソルのクライアント座標に適用されているカメラ座標変換を返します。 More...

Function Documentation

◆ ClipToWindow()

void s3d::Cursor::ClipToWindow ( bool clip )

マウスカーソルの移動範囲をクライアント画面に制限します

Parameters

clip	制限を設定する場合 true, 解除する場合は false

◆ Delta()

Point s3d::Cursor::Delta ( )

noexcept

直前のフレームから現在のフレームまでのマウスカーソルの移動量（ピクセル）を返します。

Remarks: Cursor::Pos() - Cursor::PreviousPos() と同値です。

Returns: 直前のフレームから現在のフレームまでのマウスカーソルの移動量 (ピクセル)

◆ DeltaF()

Vec2 s3d::Cursor::DeltaF ( )

noexcept

直前のフレームから現在のフレームまでのマウスカーソルの移動量（ピクセル）を返します。

Remarks: Cursor::PosF() - Cursor::PreviousPosF() と同値です。; 移動量が小数値を含む場合があります。

Returns: 直前のフレームから現在のフレームまでのマウスカーソルの移動量 (ピクセル)

◆ DeltaRaw()

Point s3d::Cursor::DeltaRaw ( )

noexcept

直前のフレームから現在のフレームまでの未変換のマウスカーソルの移動量（ピクセル）を返します。

Remarks: Cursor::PosRaw() - Cursor::PreviousPosRaw() と同値です。

Returns: 直前のフレームから現在のフレームまでの未変換のマウスカーソルの移動量 (ピクセル)

◆ GetCameraTransform()

const Mat3x2& s3d::Cursor::GetCameraTransform ( )

noexcept

マウスカーソルのクライアント座標に適用されているカメラ座標変換を返します。

Returns: 適用されているカメラ座標変換

◆ GetLocalTransform()

const Mat3x2& s3d::Cursor::GetLocalTransform ( )

noexcept

マウスカーソルのクライアント座標に適用されているローカル座標変換を返します。

Returns: 適用されているローカル座標変換

◆ IsClippedToWindow()

bool s3d::Cursor::IsClippedToWindow ( )

noexcept

マウスカーソルの移動範囲をクライアント画面に制限されているかを返します。

Returns: 制限されている場合 true, それ以外の場合は false

◆ OnClientRect()

bool s3d::Cursor::OnClientRect ( )

マウスカーソルがクライアント画面上にあるかを返します。

Returns: マウスカーソルがクライアント画面上にある場合 true, それ以外の場合は false

◆ Pos()

Point s3d::Cursor::Pos ( )

noexcept

現在のフレームにおける、マウスカーソルのクライアント座標（ピクセル）を返します。

Returns: 現在のフレームにおける、マウスカーソルの座標 (ピクセル)

◆ PosF()

Vec2 s3d::Cursor::PosF ( )

noexcept

現在のフレームにおける、マウスカーソルのクライアント座標（ピクセル）を返します。

Remarks: 座標が小数値を含む場合があります。

Returns: 現在のフレームおける、マウスカーソルの座標 (ピクセル)

◆ PosRaw()

Point s3d::Cursor::PosRaw ( )

noexcept

現在のフレームにおける、未変換のマウスカーソルのクライアント座標（ピクセル）を返します。

Returns: 現在のフレームおける、未変換のマウスカーソルの座標 (ピクセル)

◆ PreviousPos()

Point s3d::Cursor::PreviousPos ( )

noexcept

直前のフレームにおける、マウスカーソルのクライアント座標（ピクセル）を返します。

Returns: 直前のフレームおける、マウスカーソルの座標 (ピクセル)

◆ PreviousPosF()

Vec2 s3d::Cursor::PreviousPosF ( )

noexcept

直前のフレームにおける、マウスカーソルのクライアント座標（ピクセル）を返します。

Remarks: 座標が小数値を含む場合があります。

Returns: 直前のフレームおける、マウスカーソルの座標 (ピクセル)

◆ PreviousPosRaw()

Point s3d::Cursor::PreviousPosRaw ( )

noexcept

直前のフレームにおける、未変換のマウスカーソルのクライアント座標（ピクセル）を返します。

Returns: 直前のフレームおける、未変換のマウスカーソルの座標 (ピクセル)

◆ RegisterCustomCursorStyle()

bool s3d::Cursor::RegisterCustomCursorStyle	(	StringView	name,
		const Image &	image,
		Point	hotSpot = `Point{ 0, 0 }`
	)

カスタムのマウスカーソルを登録します。

Parameters

name	カスタムマウスカーソルの名前
image	カスタムマウスカーソルの画像
hotSpot	画像中のクリック位置

Returns: カスタムのマウスカーソルの登録に成功した場合 true, それ以外の場合は false

◆ RequestStyle() [1/2]

void s3d::Cursor::RequestStyle ( CursorStyle style )

現在のフレームのマウスカーソルを、指定したスタイルにするようリクエストします。

Parameters

style カーソルのスタイル

◆ RequestStyle() [2/2]

void s3d::Cursor::RequestStyle ( StringView name )

現在のフレームのマウスカーソルを、指定したカスタムマウスカーソルにするようリクエストします。

Parameters

name	カスタムマウスカーソルの名前

◆ ScreenDelta()

Point s3d::Cursor::ScreenDelta ( )

noexcept

直前のフレームから現在のフレームまでの、スクリーン上でのマウスカーソルの移動量（ピクセル）を返します。

Remarks: Cursor::ScreenPos() - Cursor::ScreenPreviousPos() と同値です。

Returns: 直前のフレームから現在のフレームまでのスクリーン上でのマウスカーソルの移動量 (ピクセル)

◆ ScreenPos()

Point s3d::Cursor::ScreenPos ( )

noexcept

現在のフレームにおける、マウスカーソルのスクリーン座標（ピクセル）を返します。

Returns: 現在のフレームおける、マウスカーソルのスクリーン座標 (ピクセル)

◆ ScreenPreviousPos()

Point s3d::Cursor::ScreenPreviousPos ( )

noexcept

直前のフレームにおける、マウスカーソルのスクリーン座標（ピクセル）を返します。

Returns: 直前のフレームおける、マウスカーソルのスクリーン座標 (ピクセル)

◆ SetDefaultStyle()

void s3d::Cursor::SetDefaultStyle ( CursorStyle style )

アプリケーションのデフォルトのマウスカーソルを設定します。

Parameters

style カーソルのスタイル

◆ SetPos() [1/2]

void s3d::Cursor::SetPos	(	int32	x,
		int32	y
	)

マウスカーソルを指定したクライアント座標に移動させます。

Parameters

x	移動先の X 座標 (ピクセル)
y	移動先の Y 座標 (ピクセル)

◆ SetPos() [2/2]

void s3d::Cursor::SetPos ( Point pos )

マウスカーソルを指定したクライアント座標に移動させます。

Parameters

pos	移動先の座標 (ピクセル)

Functions

Function Documentation

◆ ClipToWindow()

◆ Delta()

◆ DeltaF()

◆ DeltaRaw()

◆ GetCameraTransform()

◆ GetLocalTransform()

◆ IsClippedToWindow()

◆ OnClientRect()

◆ Pos()

◆ PosF()

◆ PosRaw()

◆ PreviousPos()

◆ PreviousPosF()

◆ PreviousPosRaw()

◆ RegisterCustomCursorStyle()

◆ RequestStyle() [1/2]

◆ RequestStyle() [2/2]

◆ ScreenDelta()

◆ ScreenPos()

◆ ScreenPreviousPos()

◆ SetDefaultStyle()

◆ SetPos() [1/2]

◆ SetPos() [2/2]