ISteamHTMLSurface Interface （Steamworks 文献库）

Steamworks 文献库

ISteamHTMLSurface Interface

Steamworks 文献库 > Steamworks API 索引 > ISteamHTMLSurface Interface

用于渲染 HTML 页面并与之互动的接口。

您可直接在游戏或应用程序内使用此接口渲染并显示 HTML 页面。在使用此接口前必须调用 Init，在使用完毕后调用 Shutdown。

此接口基于 Chromium 嵌入式框架（Chromium Embedded Framework）构建并支持 HTML5 标记。

参见 Steam HTML Surface 了解更多信息。

成员函数

ISteamHTMLSurface 的成员函数通过全局访问器函数 SteamHTMLSurface()调用。

AddHeader

void AddHeader( HHTMLBrowser unBrowserHandle, const char *pchKey, const char *pchValue );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要增加标头的 surface 的句柄。
pchKey	const char *	要增加的标头名。
pchValue	const char *	与键相关的标头值。

给来自此浏览器的任何 HTTP 请求增加标头。

标准请求字段的完整列表可参见维基页面。

AllowStartRequest

void AllowStartRequest( HHTMLBrowser unBrowserHandle, bool bAllowed );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	正在导航的 surface 的句柄。
bAllowed	bool	允许或拒绝导航至当前的开始请求。

设置是否允许或取消待处理加载。

注意：在响应 HTML_StartRequest_t 回调时必须调用此函数。

可以使用此功能来限制 HTML surface 中允许的有效页面。

CopyToClipboard

void CopyToClipboard( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要从中复制文本的 surface 的句柄。

从 HTML surface 中的当前页面里将当前已选中文本复制入本地剪贴板。

CreateBrowser

SteamAPICall_t CreateBrowser( const char *pchUserAgent, const char *pchUserCSS );

名称	类型	描述
pchUserAgent	const char *	将字符串追加至浏览器的常规用户代理字符串，允许您检测 web 服务器上的客户端。如果不需要本功能，使用 NULL。
pchUserCSS	const char *	让您将此浏览器上显示的每个页面均设置为 CSS 样式。如果不需要本功能，使用 NULL。

为显示一个 HTML 页面创建一个浏览器对象。

注意：必须已经为 HTML_BrowserReady_t、HTML_StartRequest_t、HTML_JSAlert_t、HTML_JSConfirm_t 及 HTML_FileOpenDialog_t 实现了回调句柄！
如果不实现这些回调句柄，浏览器可能会挂起，而不会导航至新页面或触发 javascript 弹窗！

注意：使用完浏览器后必须调用 RemoveBrowser 来释放各关联资源，否则会导致内存泄漏。

您可能需要调用 SetSize 和LoadURL 以开始使用您的显示 surface。

返回： SteamAPICall_t，与 HTML_BrowserReady_t 调用结果一起使用。

ExecuteJavascript

void ExecuteJavascript( HHTMLBrowser unBrowserHandle, const char *pchScript );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	正在导航的 surface 的句柄。
pchScript	const char *	要运行的 javascript 脚本。

在当前已加载页运行 javascript 脚本。

FileLoadDialogResponse

void FileLoadDialogResponse( HHTMLBrowser unBrowserHandle, const char **pchSelectedFiles );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	希望生成文件打开对话框的 surface 的句柄。
pchSelectedFiles	const char **	应为用户已选择文件的绝对文件路径数组。如果用户没有选择任何文件，则为 NULL。

让您对要打开文件加载对话框的页面做出回应。

注意：在响应 HTML_FileOpenDialog_t 回调时必须调用此函数。

Find

void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要在其中寻找字符串的 surface 的句柄。
pchSearchStr	const char *	要搜索的字符串。
bCurrentlyInFind	bool	在后续调用中将此设置为 true，以循环直至下一匹配字符串。
bReverse	bool	从下向上搜索吗？

在 HTML surface 的当前页面寻找字符串。

在您选择的浏览器中等同于“ctrl+f”。将高亮显示所有匹配字符串。

当输入字符串已经改变或您想停止搜索时，应调用 StopFind。

返回： void
触发一个 HTML_SearchResults_t 回调。

GetLinkAtPosition

void GetLinkAtPosition( HHTMLBrowser unBrowserHandle, int x, int y );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要从中获得链接的 surface 的句柄。
x	int	surface 中以像素为单位的 X （宽度）位置。 (0, 0)为左上角。
y	int	surface 中以像素为单位的 Y （高度）位置。 (0, 0)为左上角。

获取 HTML surface 当前页面上特定位置的链接的详细信息。

返回： void
触发一个 HTML_LinkAtPosition_t 回调。

GoBack

void GoBack( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要导航返回至的 surface 的句柄。

在页面历史记录中向后导航。

GoForward

void GoForward( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要向前导航至的 surface 的句柄。

在页面历史记录中向前导航。

Init

bool Init();

初始化 HTML Surface API。

在使用本接口的任意其他函数前必须调用此函数。

使用完此接口后必须调用 Shutdown 来释放各关联资源，否则会导致内存泄漏！

返回： bool
true 表明 API 已成功初始化；否则返回 false。

JSDialogResponse

void JSDialogResponse( HHTMLBrowser unBrowserHandle, bool bResult );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	正在生成对话框的 surface 的句柄。
bResult	bool	将此设置为 true，以模拟按下“确定”按钮；否则设为 false，以模拟按下“Cancel”按钮。

让您对要打开 javascript 模式对话框通知的页面做出回应。

注意：在响应 HTML_JSAlert_t 和HTML_JSConfirm_t 回调时必须调用此函数。

KeyChar

void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要发送交互至的 surface 的句柄。
cUnicodeChar	uint32	此次按键的 Unicode 字符点，以及每次按键的潜在多个字符。
eHTMLKeyModifiers	EHTMLKeyModifiers	这应设置为用户当前所按的修改键的位掩码。

cUnicodeChar 是此次按键的 Unicode 字符点（也可能是每次按键的多个字符）。

KeyDown

void KeyDown( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要发送交互至的 surface 的句柄。
nNativeKeyCode	uint32	这是来自操作系统的虚拟键码值。
eHTMLKeyModifiers	EHTMLKeyModifiers	这应设置为用户当前所按的修改键的位掩码。

键盘交互，原生键码值为您操作系统的虚拟键码值。

KeyUp

void KeyUp( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要发送交互至的 surface 的句柄。
nNativeKeyCode	uint32	这是来自操作系统的虚拟键码值。
eHTMLKeyModifiers	EHTMLKeyModifiers	这应设置为用户当前所按的修改键的位掩码。

LoadURL

void LoadURL( HHTMLBrowser unBrowserHandle, const char *pchURL, const char *pchPostData );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要加载入此 URL 的 surface 的句柄。
pchURL	const char *	要加载的 URL。
pchPostData	const char *	可选择与本数据一起发送 POST 请求，如果不发送任何数据，将其设置为 NULL。

导航至特定 URL。

如果您使用 pchPostData 发送 POST 数据，则数据格式应为：name1=value1&name2=value2。

您可以加载 Chromium 嵌入式框架支持的任何 URI 方案，包括但不限于： http://, https://, ftp://, and file:///。如果未指定方案，则使用 http://。

返回： void
触发一个 HTML_StartRequest_t 回调。

MouseDoubleClick

void MouseDoubleClick( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要发送交互至的 surface 的句柄。
eMouseButton	EHTMLMouseButton	被双击的鼠标键。

告知 HTML surface 已双击一个鼠标键。

根据前次对 MouseMove 的调用，在 surface 认为鼠标所在的地方发生鼠标点击。

MouseDown

void MouseDown( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要发送交互至的 surface 的句柄。
eMouseButton	EHTMLMouseButton	被按下的鼠标键。

告知 HTML surface 已按下一个鼠标键。

根据前次对 MouseMove 的调用，在 surface 认为鼠标所在的地方发生鼠标点击。

MouseMove

void MouseMove( HHTMLBrowser unBrowserHandle, int x, int y );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要发送交互至的 surface 的句柄。
x	int	相对于 HTML surface 位置的以像素计算的 X（宽度）坐标。 (0, 0)是左上角。
y	int	相对于 HTML surface 位置的以像素计算的 Y（高度）坐标。 (0, 0)是左上角。

告知 HTML surface 鼠标的位置。

MouseUp

void MouseUp( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要发送交互至的 surface 的句柄。
eMouseButton	EHTMLMouseButton	被松开的鼠标键。

告知 HTML surface 已松开一个鼠标键。

根据前次对 MouseMove 的调用，在 surface 认为鼠标所在的地方发生鼠标点击。

MouseWheel

void MouseWheel( HHTMLBrowser unBrowserHandle, int32 nDelta );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要发送交互至的 surface 的句柄。
nDelta	int32	要滚动的像素数量。

告知 HTML surface 鼠标滚轮已移动。

PasteFromClipboard

void PasteFromClipboard( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要粘贴入其中的 surface 的句柄。

从本地剪贴板复制到 HTML surface 的当前页面。

Reload

void Reload( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要重新加载的 surface 的句柄。

刷新当前页面。

重新加载非常有可能找到本地缓存而非通过网络进行。在您选择的浏览器中等同于 F5 或 Ctrl+R。

RemoveBrowser

void RemoveBrowser( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要释放的浏览器句柄。

使用完 HTML surface 后必须调用此函数来释放各关联资源。

未进行此操作会导致内存泄漏！

SetBackgroundMode

void SetBackgroundMode( HHTMLBrowser unBrowserHandle, bool bBackgroundMode );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要在其上设置背景模式的 surface 的句柄。
bBackgroundMode	bool	切换背景模式开关。

启用或禁用资源不足的背景模式。在 javascript 及重绘计时器受到限制的地方，资源会从内存中清除得更彻底，而音频或视频元素则暂停。

启用背景模式时，所有的 HTML5 视频及音频对象会执行“.pause()”，并获得 “._steam_background_paused = 1” 的属性。
禁用背景模式时，所有具有上述属性的视频或音频对象均会恢复“.play()”。

SetCookie

void SetCookie( const char *pchHostname, const char *pchKey, const char *pchValue, const char *pchPath = "/", RTime32 nExpires = 0, bool bSecure = false, bool bHTTPOnly = false );

名称	类型	描述
pchHostname	const char *	要为其设置 cookie 的服务器主机名。（“Host”属性）
pchKey	const char *	要设置的 cookie 名。
pchValue	const char *	要设置的 cookie 值。
pchPath	const char *	在 cookie 上设置“Path”属性。您可借此将 cookie 限制在域的某个特定路径，如“/accounts”。
nExpires	RTime32	在 cookie 上将“Expires”属性设置为特定的 Unix 时间戳（自 1970 年 1 月 1 日起的秒数）。
bSecure	bool	设置“Secure”属性。
bHTTPOnly	bool	设置“HttpOnly”属性。

为特定的主机名设置 webcookie。

您可以在维基页面阅读更多有关设置 cookie 的说明。

SetHorizontalScroll

void SetHorizontalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	设置水平滚动位置的 surface 句柄。
nAbsolutePixelScroll	uint32	要滚动至的绝对像素位置。 0 为左侧，`HTML_HorizontalScroll_t.unScrollMax` 为右侧。

水平滚动当前页面。

返回： void
触发一个 HTML_HorizontalScroll_t 回调。

另见： HTML_HorizontalScroll_t、 SetVerticalScroll、HTML_VerticalScroll_t

SetKeyFocus

void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要在其上设置键盘焦点的 surface 的句柄。
bHasKeyFocus	bool	启动还是关闭键盘焦点？

告知 HTML surface 当前是否有键盘焦点，在文本控件中用来显示 I 形光标以示区别的控件。

SetPageScaleFactor

void SetPageScaleFactor( HHTMLBrowser unBrowserHandle, float flZoom, int nPointX, int nPointY );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要缩放的 surface 的句柄。
flZoom	float	缩放大小，范围为 1（默认为100%）至 2（200%）。
nPointX	int	缩放的 X 点，以像素为单位。如果您认为无关，则使用 0。
nPointY	int	缩放的 Y 点，以像素为单位。如果您认为无关，则使用 0。

在 HTML surface 中缩放当前页面。

当前缩放比例系数可为 HTML_NeedsPaint_t.flPageScale、HTML_HorizontalScroll_t.flPageScale 及 HTML_VerticalScroll_t.flPageScale。

SetSize

void SetSize( HHTMLBrowser unBrowserHandle, uint32 unWidth, uint32 unHeight );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要设置其大小的 surface 的句柄。
unWidth	uint32	以像素为单位的 surface 的宽度。
unHeight	uint32	以像素为单位的 surface 的高度。

设置以像素为单位的 surface 的显示大小。

SetVerticalScroll

void SetVerticalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	要设置其垂直滚动位置的 surface 的句柄。
nAbsolutePixelScroll	uint32	要滚动至的绝对像素位置。 0 为上方，`HTML_VerticalScroll_t.unScrollMax` 为下方。

垂直滚动当前页面。

返回： void
触发一个 HTML_VerticalScroll_t 回调。

另见： HTML_VerticalScroll_t、SetHorizontalScroll、HTML_HorizontalScroll_t

Shutdown

bool Shutdown();

关闭 ISteamHTMLSurface 接口，释放内容及句柄。

使用完接口后，必须调用此函数以防止内存及句柄泄漏。调用此函数后本接口内所有函数均会失败，除非您再次调用 Init 进行初始化。

返回： bool
始终返回 true。

StopFind

void StopFind( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	停止查找结果的 surface 的句柄。

取消当前正在运行的查找。

另见： Find

StopLoad

void StopLoad( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	停止加载的 surface 的句柄。

停止当前 HTML 页面的加载。

ViewSource

void ViewSource( HHTMLBrowser unBrowserHandle );

名称	类型	描述
unBrowserHandle	HHTMLBrowser	查看其当前页面源的 surface 的句柄。

在默认本地文本编辑器中打开当前页面的 HTML 源代码，用于调试。

回调

以下是可以通过调用 SteamAPI_RunCallbacks 触发的回调。其中许多将响应 ISteamHTMLSurface 的成员函数直接触发。

HTML_BrowserReady_t

新的浏览器已创建，可以使用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	刚创建的浏览器的句柄，可在未来调用 ISteamHTMLSurface 时一起使用。

关联函数： CreateBrowser

HTML_CanGoBackAndForward_t

在页面历史记录状态改变了前进及后退功能时调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
bCanGoBack	bool	返回是否可以向后导航。
bCanGoForward	bool	返回是否可以向前导航。

HTML_ChangedTitle_t

浏览器内的当前页获得新标题时调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
pchTitle	const char *	页面新标题。

HTML_CloseBrowser_t

由于用户交互已请求关闭浏览器时调用。通常是由于 javascript window.close() 的调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。

HTML_FileOpenDialog_t

浏览器 surface 从 <input type="file"> 点击或类似操作中收到文件打开对话框时调用，您必须使用用户选择的文件调用 FileLoadDialogResponse。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	正在导航的 surface 的句柄。
pchTitle	const char *	对话框的名称（如 “上传图像”）
pchInitialFile	const char *	默认情况下，页面希望您设置的文件名。页面也许预期会有以该名称命名的文件，或者这是用户之前上传的文件。

HTML_FinishedRequest_t

浏览器完成加载一个页面时调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此调用所针对的 surface 的句柄。
pchURL	const char *	所加载的 URL。
pchPageTitle	const char *	已加载的页面标题。

HTML_HideToolTip_t

浏览器希望隐藏工具提示时调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。

HTML_HorizontalScroll_t

提供水平滚动条的可见度和大小详细信息。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
unScrollMax	uint32	能水平滚动的最大量。
unScrollCurrent	uint32	当前水平滚动的位置。
flPageScale	float	当前页面比例。
bVisible	bool	水平滚动条是否可见。
unPageSize	uint32	以像素为单位的页面总宽度。

关联函数： SetHorizontalScroll

HTML_JSAlert_t

浏览器希望显示 Javascript 警报对话框时调用，用户取消或直接忽略对话框时调用 JSDialogResponse。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此调用所针对的 surface 的句柄。
pchMessage	const char *	与该对话框关联的消息。

HTML_JSConfirm_t

浏览器希望显示 Javascript 确认对话框时调用，用户取消或直接忽略对话框时调用 JSDialogResponse。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此调用所针对的 surface 的句柄。
pchMessage	const char *	与该对话框关联的消息。

HTML_LinkAtPosition_t

调用 GetLinkAtPosition 的结果。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此调用所针对的 surface 的句柄。
x	uint32	不使用。
y	uint32	不使用。
pchURL	const char *	在此位置找到的 URL。如果未找到链接，则为 NULL。
bInput	bool	位于一个输入字段吗？
bLiveLink	bool

关联函数： GetLinkAtPosition

HTML_NeedsPaint_t

浏览器 surface 有待处理的绘制时调用。您在这里获得实际图像数据，以在屏幕上渲染。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
pBGRA	const char *	为此 surface 指向 B8G8R8A8 图像数据的指针，在 SteamAPI_RunCallbacks 下次被调用前有效。
unWide	uint32	`pBGRA` 纹理的总宽度。
unTall	uint32	`pBGRA` 纹理的总高度。
unUpdateX	uint32	本次更新的 damage rect 的 X 偏移。
unUpdateY	uint32	本次更新的 damage rect 的 Y 偏移。
unUpdateWide	uint32	本次更新的 damage rect 的宽度。
unUpdateTall	uint32	本次更新的 damage rect 的高度。
unScrollX	uint32	此纹理渲染时浏览器所在的水平滚动位置。
unScrollY	uint32	此纹理渲染时浏览器所在的垂直滚动位置。
flPageScale	float	此纹理渲染时浏览器的缩放比例。
unPageSerial	uint32	随每个新的页面加载而递增，可在导航至新页面时用于拒绝绘制。

HTML_NewWindow_t

浏览器已创建新的 HTML 窗口。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
pchURL	const char *	要在新窗口中加载的 URL。
unX	uint32	页面上显示弹出窗口的 X 位置。
unY	uint32	页面上显示弹出窗口的 Y 位置。
unWide	uint32	pBGRA 纹理的总宽度。
unTall	uint32	pBGRA 纹理的总高度。
unNewWindow_BrowserHandle	HHTMLBrowser	新窗口 surface 的句柄。

HTML_OpenLinkInNewTab_t

浏览器已请求在新选项卡中加载一个 URL。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
pchURL	const char *	浏览器要加载的 URL。

HTML_SearchResults_t

搜索结果。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
unResults	uint32	找到的匹配的结果数量。
unCurrentMatch	uint32	与 `unResults` 相关的当前匹配结果的序号。

关联函数： Find

HTML_SetCursor_t

浏览器希望改变鼠标光标时调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
eMouseCursor	uint32	要显示的 EMouseCursor。

HTML_ShowToolTip_t

浏览器要显示工具提示时调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
pchMsg	const char *	要显示的工具提示的文本。

HTML_StartRequest_t

浏览器希望导航至新页面时调用。

注意：必须调用 AllowStartRequest 以响应此回调！

名称	类型	描述
unBrowserHandle	HHTMLBrowser	正在导航的 surface 的句柄。
pchURL	const char *	要导航至的 URL。
pchTarget	const char *	HTML 链接目标类型（如 _blank、_self、_parent、_top）。
pchPostData	const char *	针对请求的任何发布的数据。
bIsRedirect	bool	如果为重新定向自上次加载请求的 HTTP/HTML，则为 true。

关联函数： LoadURL

HTML_StatusText_t

浏览器希望您显示信息型消息时调用。最常用于鼠标悬停在链接上方时。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
pchMsg	const char *	要显示的状态消息的文本。

HTML_UpdateToolTip_t

现有工具提示文本已更新时调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
pchMsg	const char *	工具提示的新文本。

HTML_URLChanged_t

浏览器正在导航至新 URL 时调用。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
pchURL	const char *	浏览器正在导航至的 URL。
pchPostData	const char *	任何针对本请求所发布的数据，如没有任何数据则为 NULL。
bIsRedirect	bool	如果是来自上一个载入请求的 http/html 重定向则为 true，否则为 false。
pchPageTitle	const char *	页面的标题。
bNewNavigation	bool	如页面已发生变化而非只是对浏览器历史记录 API 的调用，则为 true。

HTML_VerticalScroll_t

提供垂直滚动条可见性及大小的详细信息。

名称	类型	描述
unBrowserHandle	HHTMLBrowser	此回调所针对的 surface 的句柄。
unScrollMax	uint32	能垂直滚动的最大量。
unScrollCurrent	uint32	当前垂直滚动的位置。
flPageScale	float	当前页面比例。
bVisible	bool	垂直滚动条是否可见。
unPageSize	uint32	以像素为单位的页面总高度。

关联函数： SetVerticalScroll

枚举

以下是定义来与 ISteamHTMLSurface 一起使用的枚举。

EHTMLKeyModifiers

用来让浏览器知晓哪些键已被按下：KeyChar、KeyUp 及 KeyDown。用按位或运算符可将这些标识加到一起。

名称	值	描述
k_eHTMLKeyModifier_None	0	无修改键被按下。
k_eHTMLKeyModifier_AltDown	1 << 0	一个 Alt 键被按下。
k_eHTMLKeyModifier_CtrlDown	1 << 1	一个 Ctrl 键被按下。
k_eHTMLKeyModifier_ShiftDown	1 << 2	一个 Shift 键被按下。

EHTMLMouseButton

鼠标键被按下时让浏览器知晓：MouseUp、MouseDown、MouseDoubleClick。

名称	值	描述
eHTMLMouseButton_Left	0	左键被按下。
eHTMLMouseButton_Right	1	右键被按下。
eHTMLMouseButton_Middle	2	中间键被按下。

EMouseCursor

以下为 HTML surface 告诉您要渲染的鼠标光标列表。

名称	值	描述
dc_user	0
dc_none	1
dc_arrow	2
dc_ibeam	3
dc_hourglass	4
dc_waitarrow	5
dc_crosshair	6
dc_up	7
dc_sizenw	8
dc_sizese	9
dc_sizene	10
dc_sizesw	11
dc_sizew	12
dc_sizee	13
dc_sizen	14
dc_sizes	15
dc_sizewe	16
dc_sizens	17
dc_sizeall	18
dc_no	19
dc_hand	20
dc_blank	21	不显示任何自定义光标，只使用您的默认光标。
dc_middle_pan	22
dc_north_pan	23
dc_north_east_pan	24
dc_east_pan	25
dc_south_east_pan	26
dc_south_pan	27
dc_south_west_pan	28
dc_west_pan	29
dc_north_west_pan	30
dc_alias	31
dc_cell	32
dc_colresize	33
dc_copycur	34
dc_verticaltext	35
dc_rowresize	36
dc_zoomin	37
dc_zoomout	38
dc_help	39
dc_custom	40
dc_last	41	仅用于遍历所有光标。自定义光标始于此值并向上增加。

Typedef

以下是定义来与 ISteamHTMLSurface 一起使用的 typedef。

名称	基类型	描述
HHTMLBrowser	uint32	代表了某个 HTML surface 的唯一句柄。

常量

以下是定义来与 ISteamHTMLSurface 一起使用的常量。

名称	类型	值	描述
INVALID_HTMLBROWSER	uint32	0	表明浏览器句柄无效。您应将您的 HHTMLBrowser 句柄初始化为此值，并在页面关闭后将其重新设置为此值。
STEAMHTMLSURFACE_INTERFACE_VERSION	const char *	"STEAMHTMLSURFACE_INTERFACE_VERSION_003"