Inspección de lienzos con las Herramientas para desarrolladores de Chrome

Introducción

No importa si usas un contexto de 2D o WebGL, cualquier persona que haya trabajado con el elemento <canvas> sabe que puede ser extremadamente difícil de depurar. Trabajar con un lienzo suele implicar una lista larga y difícil de seguir de llamadas:

function draw() {

  context.clearRect(0, 0, 258, 258);
  context.fillStyle = "#EEEEEE";
  context.beginPath();
  context.arc(129, 129, 127, 0, 6.28, true);
  context.closePath();
  context.fill();

  // … and on and on
}

A veces, quieres capturar las instrucciones enviadas a un contexto de lienzo y revisarlas una por una. Afortunadamente, hay una nueva función de inspección de Canvas en las Herramientas para desarrolladores de Chrome que nos permite hacer exactamente eso.

En este artículo, te mostraré cómo usar esta función para comenzar a depurar tu trabajo de lienzo. El inspector admite contextos de 2D y WebGL, por lo que, sin importar cuál uses, deberías poder obtener información de depuración útil de inmediato.

Cómo comenzar

Para comenzar, ve a about:flags en Chrome y activa “Habilitar experimentos de Herramientas para desarrolladores”.

Habilita los experimentos de las herramientas para desarrolladores en about:flags.
Figura 1: Habilitación de los experimentos de las Herramientas para desarrolladores en about:flags

Luego, ve a Herramientas para desarrolladores y haz clic en el ícono de ajustes Ícono de engranaje en la esquina inferior derecha. Desde allí, puedes ir a Experiments y habilitar Canvas inspection:

Habilitar la inspección de Canvas en los experimentos de las Herramientas para desarrolladores
Figura 2: Habilita la inspección de Canvas en los experimentos de las Herramientas para desarrolladores

Para que los cambios se apliquen, debes cerrar y volver a abrir las Herramientas para desarrolladores (puedes usar Alt+R o Option+R, una alternativa útil).

Cuando se vuelva a abrir DevTools, ve a la sección Profiles y verás una nueva opción de Canvas Profiler.

Para empezar, notarás que el generador de perfiles de Canvas está inhabilitado. Una vez que tengas una página que contenga un lienzo que quieras depurar, simplemente presiona Habilitar y la página se volverá a cargar lista para capturar las llamadas de <canvas>:

Cómo activar el generador de perfiles de Canvas
Figura 3: Cómo activar el generador de perfiles de Canvas

Deberás decidir si quieres capturar un solo fotograma o fotogramas consecutivos, donde un fotograma es exactamente el mismo que verías en el cronograma de DevTools.

Single frame captura las llamadas hasta el final del fotograma actual y, luego, se detiene. Por otro lado, Consecutive frames captura todos los fotogramas de todos los elementos <canvas> hasta que le indiques que se detenga. El modo que elijas dependerá de cómo uses el elemento <canvas>. En el caso de una animación en curso, es posible que quieras capturar un solo fotograma. Para una animación breve que se produce en respuesta a un evento del usuario, es posible que debas capturar fotogramas consecutivos.

Elige cuántos fotogramas capturar
Figura 4: Elige cuántos fotogramas capturar

Con eso, ya está todo configurado y listo para comenzar a capturar.

Captura de fotogramas

Para capturar, simplemente presiona Start y, luego, interactúa con tu aplicación como lo harías normalmente. Después de un tiempo, vuelve a las Herramientas para desarrolladores y, si estás capturando de forma consecutiva, presiona Detener.

Ahora tienes un perfil nuevo y brillante en la lista de la izquierda, con la cantidad de llamadas de contexto capturadas en todos los elementos <canvas>. Haz clic en el perfil y verás una pantalla similar a la siguiente:

Un perfil de lienzo en las Herramientas para desarrolladores.
Figura 5: Un perfil de lienzo en las Herramientas para desarrolladores

En el panel inferior, verás una lista de todos los fotogramas capturados por los que puedes desplazarte y, a medida que hagas clic en cada uno, la captura de pantalla de la parte superior te mostrará el estado del elemento <canvas> al final de ese fotograma. Si tienes varios elementos <canvas>, puedes elegir cuál se muestra con el menú que se encuentra justo debajo de la captura de pantalla.

Elegir el contexto del lienzo
Figura 6: Elige el contexto de tu lienzo

Dentro del fotograma, verás grupos de llamadas de dibujo. Cada grupo de llamadas de dibujo contiene una sola llamada de dibujo, que será la última llamada del grupo. ¿Qué es una llamada de dibujo? Para un contexto 2D, serían elementos como clearRect(), drawImage(), fill(), stroke(), putImageData() o cualquier función de renderización de texto, y para WebGL, serían clear(), drawArrays() o drawElements(). Es, básicamente, cualquier cosa que cambie el contenido del búfer de dibujo actual. (Si no te interesan los gráficos, puedes pensar en un búfer como un mapa de bits con píxeles que estamos manipulando).

Ahora, todo lo que debes hacer es recorrer la lista. Puedes hacerlo a nivel de fotograma, grupo de llamadas de dibujo o llamada. Independientemente de cómo elijas recorrer la lista (hay botones justo debajo de la captura de pantalla que te ayudan a navegar rápidamente), verás el contexto en ese punto, lo que significa que puedes encontrar y corregir errores rápidamente a medida que surgen.

Botones de navegación para saltar de una lista a otra de forma conveniente
Figura 7: Botones de navegación para saltar de una lista a otra de forma conveniente

Detecta la diferencia

Otra función útil es la capacidad de ver qué propiedades y variables cambiaron entre dos llamadas.

Para verla, simplemente haz clic en el botón de la barra lateral (Ícono de barra lateral.) y aparecerá una vista nueva. A medida que avances por las llamadas de dibujo, verás las propiedades que se actualizaron. Si colocas el cursor sobre cualquier búfer o array, se mostrará su contenido.

Detecta la diferencia

¡Hazte escuchar!

Ahora ya sabes cómo depurar tu trabajo de lienzo en las Herramientas para desarrolladores de Chrome. Si tienes comentarios sobre la herramienta Canvas Profiler, informa un error o publica un mensaje en el grupo de Herramientas para desarrolladores de Chrome. Avísanos si encuentras algún error o si hay algo más que te gustaría ver cuando inspecciones un <canvas>, ya que las herramientas de Chrome solo mejoran con el uso y los comentarios de los desarrolladores.