Win32 API 日本語リファレンス
ホーム › Media.MediaFoundation › IMFTimedTextStyle

IMFTimedTextStyle

COM
📘 Microsoft Learn (日本語) · English
IID09b2455d-b834-4f01-a347-9052e21c450e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

タイムドテキストのスタイルを表します。

メソッド 13

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetName(LPWSTR* name)

タイムドテキストスタイルの名前を取得します。

nameLPWSTR*outスタイルの名前を格納する、null 終端のワイド文字列を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 BOOL IsExternal()

タイムドテキストスタイルが外部であるかどうかを判定します。

戻り値

型: BOOL

タイムドテキストスタイルが外部であるかどうかを返します。TRUE の場合、タイムドテキストスタイルは外部です。それ以外の場合は FALSE です。

vtbl 5 HRESULT GetFontFamily(LPWSTR* fontFamily)

タイムドテキストスタイルのフォントファミリーを取得します。

fontFamilyLPWSTR*outスタイルのフォントファミリーを格納する、null 終端のワイド文字列を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 6 HRESULT GetFontSize(DOUBLE* fontSize, MF_TIMED_TEXT_UNIT_TYPE* unitType)

タイムドテキストスタイルのフォントサイズを取得します。

fontSizeDOUBLE*outタイムドテキストスタイルのフォントサイズを受け取る変数へのポインター。
unitTypeMF_TIMED_TEXT_UNIT_TYPE*outタイムドテキストスタイルを測定する単位を指定する MF_TIMED_TEXT_UNIT_TYPE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 7 HRESULT GetColor(MFARGB* color)

タイムドテキストスタイルの色を取得します。

colorMFARGB*out色を記述する MFARGB 構造体を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 8 HRESULT GetBackgroundColor(MFARGB* bgColor)

タイムドテキストスタイルの背景色を取得します。

bgColorMFARGB*out背景色を記述する MFARGB 構造体を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 9 HRESULT GetShowBackgroundAlways(BOOL* showBackgroundAlways)

タイムドテキストのスタイルが常に背景を表示するかどうかを判定します。

showBackgroundAlwaysBOOL*outタイムドテキストのスタイルが常に背景を表示するかどうかを指定する値を受け取る変数へのポインター。背景が常に表示される場合、変数は TRUE を指定します。それ以外の場合は FALSE です。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 10 HRESULT GetFontStyle(MF_TIMED_TEXT_FONT_STYLE* fontStyle)

タイムドテキストスタイルのフォントスタイルを取得します。

fontStyleMF_TIMED_TEXT_FONT_STYLE*outフォントスタイルを指定する MF_TIMED_TEXT_FONT_STYLE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 11 HRESULT GetBold(BOOL* bold)

タイムドテキストのスタイルが太字であるかどうかを判定します。

boldBOOL*outタイムドテキストのスタイルが太字であるかどうかを指定する値を受け取る変数へのポインター。スタイルが太字の場合、変数は TRUE を指定します。それ以外の場合は FALSE です。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 12 HRESULT GetRightToLeft(BOOL* rightToLeft)

タイムドテキストスタイルの右から左への書字モードが有効であるかどうかを判定します。

rightToLeftBOOL*out右から左への書字モードが有効であるかどうかを指定する値を受け取る変数へのポインター。右から左への書字モードが有効な場合、変数は TRUE を指定します。それ以外の場合は FALSE です。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 13 HRESULT GetTextAlignment(MF_TIMED_TEXT_ALIGNMENT* textAlign)

タイムドテキストスタイルのテキスト配置を取得します。

textAlignMF_TIMED_TEXT_ALIGNMENT*outテキスト配置を指定する MF_TIMED_TEXT_ALIGNMENT 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 14 HRESULT GetTextDecoration(DWORD* textDecoration)

タイムドテキストスタイルにおけるテキストの装飾方法を取得します。

textDecorationDWORD*outビット単位の OR 演算によって結合された MF_TIMED_TEXT_DECORATION 型の値の組み合わせを受け取る変数へのポインター。結果として得られる値は、テキストの装飾方法を指定します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 15 HRESULT GetTextOutline(MFARGB* color, DOUBLE* thickness, DOUBLE* blurRadius, MF_TIMED_TEXT_UNIT_TYPE* unitType)

タイムドテキストスタイルのテキストアウトラインを取得します。

colorMFARGB*out色を記述する MFARGB 構造体を受け取る変数へのポインター。
thicknessDOUBLE*out太さを受け取る変数へのポインター。
blurRadiusDOUBLE*outぼかし半径を受け取る変数へのポインター。
unitTypeMF_TIMED_TEXT_UNIT_TYPE*outタイムドテキストを測定する単位を指定する MF_TIMED_TEXT_UNIT_TYPE 型の値を受け取る変数へのポインター。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IMFTimedTextStyle "{09B2455D-B834-4F01-A347-9052E21C450E}"
#usecom global IMFTimedTextStyle IID_IMFTimedTextStyle "{}"
#comfunc global IMFTimedTextStyle_GetName                  3 var
#comfunc global IMFTimedTextStyle_IsExternal               4
#comfunc global IMFTimedTextStyle_GetFontFamily            5 var
#comfunc global IMFTimedTextStyle_GetFontSize              6 var,var
#comfunc global IMFTimedTextStyle_GetColor                 7 var
#comfunc global IMFTimedTextStyle_GetBackgroundColor       8 var
#comfunc global IMFTimedTextStyle_GetShowBackgroundAlways  9 var
#comfunc global IMFTimedTextStyle_GetFontStyle             10 var
#comfunc global IMFTimedTextStyle_GetBold                  11 var
#comfunc global IMFTimedTextStyle_GetRightToLeft           12 var
#comfunc global IMFTimedTextStyle_GetTextAlignment         13 var
#comfunc global IMFTimedTextStyle_GetTextDecoration        14 var
#comfunc global IMFTimedTextStyle_GetTextOutline           15 var,var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。