Documentación de Steamworks
Interfaz ISteamHTMLSurface
Interfaz para mostrar páginas HTML e interactuar con ellas.

Esta interfaz se puede usar para mostrar y visualizar páginas HTML directamente en el juego o la aplicación. Debes llamar a Init antes de usar esta interfaz y a Shutdown cuando hayas terminado de usarla.

Está desarrollada a partir de Chromium Embedded Framework y es compatible con HTML5.

Consulta Superficies HTML de Steam para obtener más información.

Funciones miembro

Las funciones miembro para ISteamHTMLSurface se llaman a través de la función de acceso global SteamHTMLSurface().

AddHeader

void AddHeader( HHTMLBrowser unBrowserHandle, const char *pchKey, const char *pchValue );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserEl handle de la superficie a la que se le agrega la cabecera.
pchKeyconst char *El nombre de la cabecera a agregar.
pchValueconst char *El valor de la cabecera a asociar con la clave.

Añade una cabecera a cualquier solicitud HTTP procedente de este navegador.

Una lista completa de campos de solicitud estándar están disponibles aquí en wikipedia.

AllowStartRequest

void AllowStartRequest( HHTMLBrowser unBrowserHandle, bool bAllowed );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserEl handle de la superficie que se está navegando.
bAllowedboolPermite o deniega la navegación a la solicitud de inicio actual.

Establece si se permite una carga pendiente o debe ser cancelada.
NOTA:DEBES llamarla como respuesta a la función callback HTML_StartRequest_t.

Esta característica se puede usar para limitar las páginas que se permiten en una superficie HTML.

CopyToClipboard

void CopyToClipboard( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie desde la que se va a copiar el texto.

Copia en el portapapeles local el texto seleccionado de la página actual en una superficie HTML.

CreateBrowser

SteamAPICall_t CreateBrowser( const char *pchUserAgent, const char *pchUserCSS );
NombreTipoDescripción
pchUserAgentconst char *Anexa la cadena a la cadena de agente de usuario general del navegador, lo que te permite detectar tu cliente en servidores web. Pon NULL si no necesitas esta funcionalidad.
pchUserCSSconst char *Esto permite asignar un estilo CSS a todas las páginas mostradas por este navegador. Pon NULL si no necesitas esta funcionalidad.

Crea un objeto de navegador para mostrar una página HTML.
NOTA: ¡Debes haber implementado los handle para las funciones callback HTML_BrowserReady_t, HTML_StartRequest_t, HTML_JSAlert_t, HTML_JSConfirm_t y HTML_FileOpenDialog_t!
Si no implementas estos handle, ¡el navegador puede parecer que se bloquea en lugar de navegar a nuevas páginas o desencadenar ventanas emergentes de JavaScript!

NOTA: Tienes que llamar a RemoveBrowser cuando hayas terminado de usar este navegador para liberar los recursos asociados. Si no lo haces, habrá una pérdida de memoria.

Querrás llamar a SetSize y LoadURL para comenzar a usar tu superficie de visualización.

Devuelve: SteamAPICall_t para ser usado con el resultado de la llamada a HTML_BrowserReady_t.

ExecuteJavascript

void ExecuteJavascript( HHTMLBrowser unBrowserHandle, const char *pchScript );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserEl handle de la superficie que se está navegando.
pchScriptconst char *El script de JavaScript a ejecutar.

Ejecuta un script de JavaScript en la página cargada.

FileLoadDialogResponse

void FileLoadDialogResponse( HHTMLBrowser unBrowserHandle, const char **pchSelectedFiles );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie que quiere generar un diálogo de apertura de archivo.
pchSelectedFilesconst char **Debe ser un vector de rutas absolutas a los archivos que ha seleccionado el usuario. NULL si el usuario no seleccionó ningún archivo.

Te permite reaccionar a una página que quiere abrir un cuadro de diálogo de carga de archivos.
NOTA:DEBES llamar esto en respuesta a la función callback HTML_FileOpenDialog_t.

Find

void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie en la que se busca la cadena.
pchSearchStrconst char *La cadena que se quiere encontrar.
bCurrentlyInFindboolEstablece esto a true en las llamadas subsiguientes para pasar a la siguiente cadena coincidente.
bReversebool¿Buscar desde abajo hacia arriba?

Busca una cadena en la página actual de una superficie HTML.

Esto equivale a pulsar "Ctrl+F" en el navegador. Resaltará todas las cadenas que coincidan.

Debes llamar a StopFind cuando la cadena de entrada haya cambiado o desees detener la búsqueda.

Devuelve: void
Activa la función callback HTML_SearchResults_t.

GetLinkAtPosition

void GetLinkAtPosition( HHTMLBrowser unBrowserHandle, int x, int y );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie desde la que se obtiene un enlace.
xintPosición X (ancho) en píxeles dentro de la superficie. (0, 0) es la esquina superior izquierda.
yintPosición Y (alto) en píxeles dentro de la superficie. (0, 0) es la esquina superior izquierda.

Recupera detalles de un vínculo en la posición especificada de la página actual en una superficie HTML.

Devuelve: void
Activa la función callback HTML_LinkAtPosition_t.

GoBack

void GoBack( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a retroceder.

Retrocede en el historial de páginas.

GoForward

void GoForward( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para navegar hacia adelante.

Avanza en el historial de páginas.

Init

bool Init();
Inicializa la API de la superficie HTML.

Hay que llamar a esta función antes de usar cualquier otra función en esta interfaz.

Es necesario llamar a la función Shutdown al terminar de usar la interfaz para liberar los recursos asociados. En caso contrario, ¡habrá una pérdida de memoria!

Devuelve: bool
true si la API se inicializó con éxito; de lo contrario, false.

JSDialogResponse

void JSDialogResponse( HHTMLBrowser unBrowserHandle, bool bResult );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie que va a generar un diálogo.
bResultboolEstablece esto en true para simular que se pulsa el botón «Aceptar», de lo contrario, false para "Cancelar".

Te permite reaccionar a una página que intenta abrir un cuadro de diálogo modal de JavaScript.
NOTA:DEBES llamar esto en respuesta a las funciones callback HTML_JSAlert_t y HTML_JSConfirm_t.

KeyChar

void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a enviar la interacción.
cUnicodeCharuint32Punto de código del carácter Unicode de la tecla pulsada; puede haber varios caracteres por pulsación.
eHTMLKeyModifiersEHTMLKeyModifiersSe debe establecer como una máscara de bits de las teclas modificadoras que está pulsado el usuario.

cUnicodeChar es el punto de código del carácter Unicode de la tecla pulsada (puede haber varios caracteres por pulsación)

KeyDown

void KeyDown( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a enviar la interacción.
nNativeKeyCodeuint32Valor del keycode virtual del SO.
eHTMLKeyModifiersEHTMLKeyModifiersSe debe establecer como una máscara de bits de las teclas modificadoras que está pulsado el usuario.

Interacciones de teclado. El keycode nativo es el código de tecla virtual del SO.

KeyUp

void KeyUp( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a enviar la interacción.
nNativeKeyCodeuint32Valor del keycode virtual del SO.
eHTMLKeyModifiersEHTMLKeyModifiersSe debe establecer como una máscara de bits de las teclas modificadoras que está pulsando el usuario.

LoadURL

void LoadURL( HHTMLBrowser unBrowserHandle, const char *pchURL, const char *pchPostData );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserEl handle de la superficie en la que se va a cargar este URL.
pchURLconst char *El URL a cargar.
pchPostDataconst char *Envía opcionalmente una solicitud POST con estos datos; se debe establecer como NULL si no se van a enviar datos.

Navega al URL especificado.

Si pchPostData contiene datos para enviar en una solicitud POST, los datos deben formatearse como: name1=value1&name2=value2.

Puedes cargar cualquier esquema de URI compatible con Chromium Embedded Framework, entre otros: http://, https://, ftp:// y file:///. Si no se especifica ningún esquema, se utiliza http://.

Devuelve: void
Activa la función callback HTML_StartRequest_t.

MouseDoubleClick

void MouseDoubleClick( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a enviar la interacción.
eMouseButtonEHTMLMouseButtonBotón del ratón con el que se ha hecho doble clic.

Indica a una superficie HTML que se ha hecho doble clic con un botón del ratón.

El clic se producirá donde la superficie cree que se encuentra el ratón, según la posición que tenía la última vez que se llamó a MouseMove.

MouseDown

void MouseDown( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a enviar la interacción.
eMouseButtonEHTMLMouseButtonBotón del ratón que se ha pulsado.

Indica a una superficie HTML que se ha pulsado un botón del ratón.

El clic se producirá donde la superficie cree que se encuentra el ratón, según la posición que tenía la última vez que se llamó a MouseMove.

MouseMove

void MouseMove( HHTMLBrowser unBrowserHandle, int x, int y );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a enviar la interacción.
xintCoordenada X (ancho) en píxeles relativa a la posición de la superficie HTML. (0, 0) es la parte superior izquierda.
yintCoordenada Y (alto) en píxeles relativa a la posición de la superficie HTML. (0, 0) es la parte superior izquierda.

Indica a la superficie HTML dónde se encuentra el ratón.

MouseUp

void MouseUp( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a enviar la interacción.
eMouseButtonEHTMLMouseButtonBotón del ratón que se ha soltado.

Indica a una superficie HTML que se ha soltado un botón del ratón.

El clic se producirá donde la superficie cree que se encuentra el ratón, según la posición que tenía la última vez que se llamó a MouseMove.

MouseWheel

void MouseWheel( HHTMLBrowser unBrowserHandle, int32 nDelta );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie a la que se va a enviar la interacción.
nDeltaint32Número de píxeles a desplazar.

Indica a la superficie HTML que la rueda del ratón se ha movido.

PasteFromClipboard

void PasteFromClipboard( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserEl handle de la superficie en la que se va a pegar.

Pega el contenido del portapapeles local en la página actual de una superficie HTML.

Reload

void Reload( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie que se va a recargar.

Actualiza la página actual.

Lo más probable es que la recarga utilice la caché local en lugar usar la red. Esto equivale a pulsar F5 o Ctrl+R en el navegador.

RemoveBrowser

void RemoveBrowser( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserEl handle del navegador que se va a liberar.

Es necesario hacer esta llamada al terminar de usar la interfaz para liberar los recursos asociados.

En caso contrario, ¡habrá una pérdida de memoria!

SetBackgroundMode

void SetBackgroundMode( HHTMLBrowser unBrowserHandle, bool bBackgroundMode );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie que se va establecer en modo de segundo plano.
bBackgroundModeboolActivar o desactivar el modo de segundo plano.

Activa o desactiva un modo de segundo plano con bajo consumo de recursos, en el que se limita el uso de JavaScript y los temporizadores de volver a dibujar, se purgan los recursos de memoria de forma más agresiva y se ponen en pausa los elementos de audio y vídeo.

Cuando el modo de segundo plano está habilitado, todos los objetos de vídeo y audio HTML5 ejecutarán ".pause()" y obtendrán la propiedad "._ steam_background_paused = 1".
Cuando el modo en segundo plano está deshabilitado, cualquier objeto de vídeo o audio que contenga esa propiedad, se reanudará con ".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 );
NombreTipoDescripción
pchHostnameconst char *El nombre de host del servidor en el que establecer la cookie. (atributo "Host")
pchKeyconst char *El nombre de la cookie que se va a establecer.
pchValueconst char *El valor de la cookie que se va a establecer.
pchPathconst char *Establece el atributo "Path" en la cookie. Se puede usar para restringir la cookie a una ruta específica del dominio. por ejemplo, "/accounts"
nExpiresRTime32Establece el atributo 'Expires' de la cookie en la marca de tiempo especificada en formato de tiempo Unix (segundos transcurridos desde el 1 de enero de 1970).
bSecureboolEstablece el atributo "Secure".
bHTTPOnlyboolEstablece el atributo "HttpOnly".

Establece una cookie para un nombre de host específico.

Puedes leer más sobre los detalles específicos de la configuración de cookies aquí en wikipedia.

SetHorizontalScroll

void SetHorizontalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie en la que se va a establecer la posición de desplazamiento horizontal.
nAbsolutePixelScrolluint32La posición absoluta en píxeles a la que desplazarse. 0 es la izquierda y HTML_HorizontalScroll_t.unScrollMax es el lado derecho.

Desplaza la página actual horizontalmente.

Devuelve: void
Activa la función callback HTML_HorizontalScroll_t.


Véase también: HTML_HorizontalScroll_t, SetVerticalScroll, HTML_VerticalScroll_t

SetKeyFocus

void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie que va a recibir el foco del teclado.
bHasKeyFocusbool¿Activar o desactivar recibir el foco del teclado?

Indica a una superficie HTML si tiene el foco del teclado. Entre otras cosas, controla si se muestra el cursor parpadeante de texto I en cajas de texto.

SetPageScaleFactor

void SetPageScaleFactor( HHTMLBrowser unBrowserHandle, float flZoom, int nPointX, int nPointY );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie que se va a aumentar.
flZoomfloatLa cantidad a ampliar, puede variar desde 1 (100 % y el valor predeterminado) hasta 2 (200 %).
nPointXintPunto X, en píxeles, sobre el que se va a ampliar. Si es indiferente, se usa 0.
nPointYintPunto Y, en píxeles, sobre el que se va a ampliar. Si es indiferente, se usa 0.

Amplía la página actual de una superficie HTML.

El factor de escala actual está disponible en HTML_NeedsPaint_t.flPageScale, HTML_HorizontalScroll_t.flPageScale y HTML_VerticalScroll_t.flPageScale.

SetSize

void SetSize( HHTMLBrowser unBrowserHandle, uint32 unWidth, uint32 unHeight );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie cuyo tamaño se va a establecer.
unWidthuint32Ancho de la superficie en píxeles.
unHeightuint32Altura de la superficie en píxeles.

Establece el tamaño de una superficie en píxeles.

SetVerticalScroll

void SetVerticalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie en la que se va a establecer la posición de desplazamiento vertical.
nAbsolutePixelScrolluint32La posición absoluta en píxeles a la que desplazarse. 0 es la parte superior y HTML_VerticalScroll_t.unScrollMax es la parte inferior.

Desplaza la página actual verticalmente.

Devuelve: void
Activa la función callback HTML_VerticalScroll_t.


Véase también: HTML_VerticalScroll_t, SetHorizontalScroll, HTML_HorizontalScroll_t

Shutdown

bool Shutdown();
Cierra la interfaz iSteamHTMLSurface, de manera que se liberan la memoria y los handle.

DEBES llamar a esta función cuando hayas terminado de usar esta interfaz para prevenir pérdidas de memoria y de handles. Después de llamarla, todas las funciones proporcionadas en esta interfaz fallarán hasta que llames a Init para reinicializar nuevamente.

Devuelve: bool
Siempre devuelve true.

StopFind

void StopFind( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie en la que se van a detener los resultados de la búsqueda.

Cancela una búsqueda que se está ejecutando.

Véase también: Find

StopLoad

void StopLoad( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie cuya carga se va parar.

Detiene la carga de la página HTML actual.

ViewSource

void ViewSource( HHTMLBrowser unBrowserHandle );
NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie cuyo código fuente se quiere visualizar.

Abre el código fuente HTML de la página actual en el editor de texto predeterminado; se usa para la depuración.

Funciones callback

Estas son funciones callback que se activan al llamar a SteamAPI_RunCallbacks. Muchas de estas se activarán directamente en respuesta a las funciones miembro de ISteamHTMLSurface.

HTML_BrowserReady_t

Se ha creado un nuevo navegador y está listo para usarse.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle del navegador que se acaba de crear; se puede usar con las llamadas futuras a ISteamHTMLSurface.

Funciones asociadas: CreateBrowser

HTML_CanGoBackAndForward_t

Se llama a esta función cuando el estado del historial de páginas cambia su capacidad de avanzar y retroceder.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
bCanGoBackboolIndica si es posible retroceder.
bCanGoForwardboolIndica si es posible avanzar.

HTML_ChangedTitle_t

Se llama a esta función cuando la página actual del navegador obtiene un título nuevo.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchTitleconst char *El nuevo título de la página.

HTML_CloseBrowser_t

Se llama cuando el navegador recibe una solicitud para cerrarse a través de una interacción del usuario; generalmente es una llamada a la función window.close() de JavaScript.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.

HTML_FileOpenDialog_t

Se llama cuando una superficie de navegador ha recibido un cuadro de diálogo de apertura de archivo a partir de un <input type="file"> clic o similar. Debes llamar a FileLoadDialogResponse con el(los) archivo(s) que el usuario selecciona.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserEl handle de la superficie que se está navegando.
pchTitleconst char *El nombre del cuadro de diálogo. (por ejemplo, "Cargar imágenes")
pchInitialFileconst char *El nombre de archivo que la página quiere que establezcas de forma predeterminada. Puede ser que esté esperando un archivo con ese nombre o que se trate del archivo que el usuario ha subido anteriormente.

HTML_FinishedRequest_t

Se llama a esta función cuando un navegador ha terminado de cargar una página.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función.
pchURLconst char *El URL que se ha cargado.
pchPageTitleconst char *El título de la página que se ha cargado.

HTML_HideToolTip_t

Se llama a esta función cuando un navegador quiere ocultar una descripción emergente.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.

HTML_HorizontalScroll_t

Aporta detalles sobre la visibilidad y el tamaño de la barra de desplazamiento horizontal.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
unScrollMaxuint32Desplazamiento horizontal máximo.
unScrollCurrentuint32Posición actual en el desplazamiento horizontal.
flPageScalefloatLa escala de la página actual.
bVisibleboolSi la barra de desplazamiento horizontal es visible.
unPageSizeuint32Ancho total de la página en píxeles.

Funciones asociadas: SetHorizontalScroll

HTML_JSAlert_t

Se llama a esta función cuando el navegador quiere mostrar un cuadro de diálogo de alerta de JavaScript. Llama a JSDialogResponse cuando el usuario lo descarta o si quieres ignorarlo inmediatamente.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchMessageconst char *El mensaje del cuadro de diálogo.

HTML_JSConfirm_t

Se llama a esta función cuando el navegador quiere mostrar un cuadro de diálogo de confirmación de JavaScript. Llama a JSDialogResponse cuando el usuario lo descarta o para ignorarlo inmediatamente.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchMessageconst char *El mensaje del cuadro de diálogo.

HTML_LinkAtPosition_t

Resultado de una llamada a GetLinkAtPosition

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
xuint32No se usa.
yuint32No se usa.
pchURLconst char *El URL encontrado en esta posición. NULL si no se encontró ningún enlace.
bInputbool¿La posición es un campo de entrada?
bLiveLinkbool

Funciones asociadas: GetLinkAtPosition

HTML_NeedsPaint_t

Se llama a esta función cuando una superficie de navegador tiene un renderizado pendiente. Aquí es donde los datos de la imagen se representan en la pantalla.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pBGRAconst char *Un puntero a los datos de la imagen de B8G8R8A8 para esta superficie, válido hasta que SteamAPI_RunCallbacks sea llamada de nuevo.
unWideuint32El ancho total de la textura pBGRA.
unTalluint32La altura total de la textura pBGRA.
unUpdateXuint32Desplazamiento horizontal del rectángulo afectado por esta actualización.
unUpdateYuint32Desplazamiento vertical del rectángulo afectado por esta actualización.
unUpdateWideuint32Ancho del rectángulo afectado por esta actualización.
unUpdateTalluint32La altura del rectángulo afectado por esta actualización.
unScrollXuint32Posición de desplazamiento horizontal en la que estaba el navegador cuando se representó esta textura.
unScrollYuint32Posición de desplazamiento vertical en la que estaba el navegador cuando se representó esta textura.
flPageScalefloatFactor de escala que tenía el navegador cuando se representó esta textura.
unPageSerialuint32Incrementado con cada nueva carga de página; úsalo para evitar que haga representaciones al navegar a páginas nuevas.

HTML_NewWindow_t

Un navegador ha creado una ventana HTML nueva.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchURLconst char *URL para cargar en la nueva ventana.
unXuint32Coordenada X de la página en la que se mostrará el elemento emergente.
unYuint32Coordenada Y de la página en la que se mostrará el elemento emergente.
unWideuint32El ancho total de la textura pBGRA.
unTalluint32La altura total de la textura pBGRA.
unNewWindow_BrowserHandleHHTMLBrowserHandle de la superficie de la nueva ventana.

HTML_OpenLinkInNewTab_t

El navegador ha solicitado cargar un URL en una pestaña nueva.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchURLconst char *URL que el navegador quiere cargar.

HTML_SearchResults_t

Resultados de una búsqueda.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
unResultsuint32Número de resultados obtenidos que coinciden con los criterios.
unCurrentMatchuint32El ordinal de la coincidencia actual relativa a unResults.

Funciones asociadas: Find

HTML_SetCursor_t

Se llama a esta función cuando un navegador quiere cambiar el cursor del ratón.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
eMouseCursoruint32El EMouseCursor para mostrar.

HTML_ShowToolTip_t

Se llama a esta función cuando un navegador quiere mostrar una descripción emergente.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchMsgconst char *Texto de la descripción emergente que se quiere mostrar.

HTML_StartRequest_t

Se llama a esta función cuando un navegador desea acceder a una nueva página.
NOTA: ¡DEBES llamar a AllowStartRequest en respuesta a esta función callback!

NombreTipoDescripción
unBrowserHandleHHTMLBrowserEl handle de la superficie que se está navegando.
pchURLconst char *URL al que quieres navegar.
pchTargetconst char *El tipo de destino del enlace html (es decir, _blank, _self, _parent, _top).
pchPostDataconst char *Cualquier dato enviado en la solicitud.
bIsRedirectboolTrue si fue un redireccionamiento http/html desde la última solicitud de carga.

Funciones asociadas: LoadURL

HTML_StatusText_t

Se llama a esta función cuando un navegador quiere que se muestre un mensaje informativo. Esto se utiliza más comúnmente cuando se pasa el cursor sobre un vínculo.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchMsgconst char *Texto del mensaje de estado para mostrar.

HTML_UpdateToolTip_t

Se llama a esta función cuando se ha actualizado el texto de una descripción emergente existente.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchMsgconst char *El nuevo texto de la descripción emergente.

HTML_URLChanged_t

Se llama a esta función cuando el navegador está accediendo a un nuevo URL

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
pchURLconst char *URL al que está accediendo el navegador.
pchPostDataconst char *Cualquier dato enviado para la solicitud, NULL si no hubo ninguno.
bIsRedirectboolTrue si esto fue un redireccionamiento http/html desde la última solicitud de carga, de lo contrario, false.
pchPageTitleconst char *El título de la página.
bNewNavigationboolEsto es true si es una página nueva y no una llamada a la API del historial del navegador.

HTML_VerticalScroll_t

Aporta detalles sobre la visibilidad y el tamaño de la barra de desplazamiento vertical.

NombreTipoDescripción
unBrowserHandleHHTMLBrowserHandle de la superficie para la que se llama a esta función callback.
unScrollMaxuint32Desplazamiento vertical máximo.
unScrollCurrentuint32Posición actual en el desplazamiento vertical.
flPageScalefloatLa escala de la página actual.
bVisibleboolSi la barra de desplazamiento vertical es visible.
unPageSizeuint32Altura total de la página en píxeles.

Funciones asociadas: SetVerticalScroll

Enums

Estas son enumeraciones definidas para usarse con ISteamHTMLSurface.

EHTMLKeyModifiers

Se utiliza para que el navegador sepa qué teclas se presionan con: KeyChar, KeyUp y KeyDown. Estas marcas pueden añadirse conjuntamente usando el operador OR a nivel de bits.

NombreValorDescripción
k_eHTMLKeyModifier_None0No se ha pulsado ningún modificador.
k_eHTMLKeyModifier_AltDown1 << 0Una de las teclas Alt está pulsada.
k_eHTMLKeyModifier_CtrlDown1 << 1Una de las teclas Ctrl está pulsada.
k_eHTMLKeyModifier_ShiftDown1 << 2Una de las teclas Mayús está pulsada.

EHTMLMouseButton

Se utiliza para que el navegador sepa qué teclas se presionan con: MouseUp, MouseDown y MouseDoubleClick.

NombreValorDescripción
eHTMLMouseButton_Left0El botón izquierdo está pulsado.
eHTMLMouseButton_Right1El botón derecho está pulsado.
eHTMLMouseButton_Middle2El botón central está pulsado.

EMouseCursor

Esto contiene una lista de los cursores de ratón que la superficie HTML puede solicitar representar.

NombreValorDescripción
dc_user0
dc_none1
dc_arrow2
dc_ibeam3
dc_hourglass4
dc_waitarrow5
dc_crosshair6
dc_up7
dc_sizenw8
dc_sizese9
dc_sizene10
dc_sizesw11
dc_sizew12
dc_sizee13
dc_sizen14
dc_sizes15
dc_sizewe16
dc_sizens17
dc_sizeall18
dc_no19
dc_hand20
dc_blank21No muestra ningún cursor personalizado, solo el cursor por defecto.
dc_middle_pan22
dc_north_pan23
dc_north_east_pan24
dc_east_pan25
dc_south_east_pan26
dc_south_pan27
dc_south_west_pan28
dc_west_pan29
dc_north_west_pan30
dc_alias31
dc_cell32
dc_colresize33
dc_copycur34
dc_verticaltext35
dc_rowresize36
dc_zoomin37
dc_zoomout38
dc_help39
dc_custom40
dc_last41Se emplea solo para iterar sobre todos los cursores. Los cursores personalizados comienzan a partir de este valor y hacia adelante.

Typedefs

Estos son los typedef definidos para usarse con ISteamHTMLSurface.

NombreTipo de baseDescripción
HHTMLBrowseruint32Representa un handle único para una superficie HTML.

Constants

Estas son constantes definidas para usarse con ISteamHTMLSurface.

NombreTipoValorDescripción
INVALID_HTMLBROWSERuint320Indica que handle del navegador no es válido. Debes inicializar tus propios handle HHTMLBrowser con este valor y luego volver a establecerlo cuando la página se cierre.
STEAMHTMLSURFACE_INTERFACE_VERSIONconst char *"STEAMHTMLSURFACE_INTERFACE_VERSION_003"