GameChatOverlay クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
ゲーム チャット オーバーレイを表します。
public ref class GameChatOverlay sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class GameChatOverlay final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class GameChatOverlay
Public NotInheritable Class GameChatOverlay
- 継承
- 属性
Windows の要件
デバイス ファミリ |
Windows 10 Creators Update (10.0.15063.0 で導入)
|
API contract |
Windows.Foundation.UniversalApiContract (v4.0 で導入)
|
例
このサンプルでは、ゲーム チャットを設定し、それにテキスト メッセージを追加する方法を示します。
#include <winrt/Windows.Gaming.UI.h>
using namespace winrt;
using namespace Windows::Gaming::UI;
...
GameChatOverlay m_gameChatOverlay{nullptr};
...
void ChatSample::SetUpGameChat(GameChatOverlayPosition position)
{
// Get the default game chat overlay object. Platforms that don't support
// it will return null.
m_gameChatOverlay = GameChatOverlay::GetDefault();
if (m_gameChatOverlay)
{
// Position the overlay in the given position.
m_gameChatOverlay.DesiredPosition(position);
}
}
// This method typically would be wired to a text entry box in order to send
// text messages.
void ChatSample::SendTextMessage(std::wstring gamertag, std::wstring message)
{
if (m_gameChatOverlay)
{
// Render the text in the overlay.
m_gameChatOverlay.AddMessage(
gamertag,
message,
GameChatMessageOrigin::Text);
}
else
{
// The game should render the outgoing message in its own UI.
}
}
void ChatSample::SetUpGameChat(GameChatOverlayPosition position)
{
// Get the default game chat overlay object. Platforms that don't support
// it will return null.
m_gameChatOverlay = GameChatOverlay::GetDefault();
if (m_gameChatOverlay)
{
// Position the overlay in the given position.
m_gameChatOverlay->DesiredPosition = position;
}
}
// This method typically would be wired to a text entry box in order to send
// text messages.
void ChatSample::SendTextMessage(String^ gamertag, String^ message)
{
if (m_gameChatOverlay)
{
// Render the text in the overlay.
m_gameChatOverlay->AddMessage(
gamertag,
message,
GameChatMessageOrigin::Text);
}
else
{
// The game should render the outgoing message in its own UI.
}
}
注釈
このクラスは、既定のゲーム チャット オーバーレイ インスタンスを取得し、オーバーレイの目的の位置を設定し、それにメッセージを追加するメソッドを提供します。
プロパティ
DesiredPosition |
ゲーム チャット オーバーレイの目的の位置。 |
メソッド
AddMessage(String, String, GameChatMessageOrigin) |
ゲーム チャット オーバーレイにメッセージをレンダリングします。 |
GetDefault() |
既定のゲーム チャット オーバーレイ インスタンスを取得します。 |