From nobody Fri Feb 16 04:00:29 2024 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4TbdWL2KPxz59Z8n; Fri, 16 Feb 2024 04:00:30 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4TbdWL1K2Dz4HD5; Fri, 16 Feb 2024 04:00:30 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1708056030; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=JQY2rei76Fo25IZUe5OjPmmxjlJ0bw+I6UDUXiFs4W8=; b=GAnmRCD9skJxR9Jfqjaw/C/qweUgKYfNbu6p/gUT4w/L9ebeNOfHDghoUDsxpQK3fsP4nw RVdWyhYyIekYTRUoNsUr3c0ylAzj5756zQFRVSWxzz6WlwoOA/dGTtdM1fWBKO+K0cze8l 0sk1fkogv1O1t9r0d5GA4adoZh7AIaNUAnEURWSgB5NlDD/0xMetSxooumcDmgc+KGFNdw DNlJpp1qV4zfzDVOV+y576dUVpruK7JCJTNeLxhdJ7s7LNat6kitLLZfP0BZt1jxxtEfyI eqfKEtlvEMHWikXEBOZEu/q8YqfvhAvNPJSkT5WzeOHxRi1znz0mB5l7K/CxUw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1708056030; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=JQY2rei76Fo25IZUe5OjPmmxjlJ0bw+I6UDUXiFs4W8=; b=dhBEAEp76QV4EN+QsYBZFSRYySoekV8UbYfN8neHM7N3vaEUEnnfpW1EGFgdB/FbB5R4xR ByGj1C0hX1AKVbvyLus6RxzBsiyehv+K/VwNFMbjW7EbVemg/whAU473361SQ6mZuhPh1u tpHaRIOfqozPeDcqI6OhsmGzF/mbP0T3Wez+le+R5R0rc2oAcLY6KESD+mO3Be6FluQF6a XtBynygVsiPMdGPbSOOoamdIyuhZpiTdp4ZhA2/fjFeHgnfWxSf8091GFAHRH3BYc5qxW+ oT3RVOlYQGLI1xGXofTHSpTgVxQ/mJ94qJYRnUx1cvC0TueLPriq+6s32ys0WA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1708056030; a=rsa-sha256; cv=none; b=JbQh+Fu4++EdkJ86e+tG28XLZ/X8vsW9C9X5lP8kfiHWYXoXCLrB22ogha/TXstTANI/ld IRdTbqD/ybmeyB3bRhY1skuRAGMIgtBNvknfyGlDHM6EgmZN+4B46bO13kHJoHElaE9J9R Nf71f6CO+8ITJ8uF5yN2+XyqYecEc16Yockb+mmTjFFR4eDjGuvsGh5MSoG5CGbwtbNZ4K BYFb+0/eyM9+nBYG3fVzV5IVhREao2oBM0OCzcdsnndDV5pGEXdmzwQlIMs6M+yLo3MmSl IjXqAoujoH0WDEK6w7sexmWAnXe+6LHV7mLt9P34HmIm95WlvfWk838MVqclKg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4TbdWL0PwCz18Xf; Fri, 16 Feb 2024 04:00:30 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 41G40TWf019158; Fri, 16 Feb 2024 04:00:30 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 41G40T2a019155; Fri, 16 Feb 2024 04:00:29 GMT (envelope-from git) Date: Fri, 16 Feb 2024 04:00:29 GMT Message-Id: <202402160400.41G40T2a019155@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Warner Losh Subject: git: a8f8c53761c4 - main - loader: Move gfx functions to gfx.lua.8 List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: a8f8c53761c4b0436c9d546ebe046003f1b3d88f Auto-Submitted: auto-generated The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=a8f8c53761c4b0436c9d546ebe046003f1b3d88f commit a8f8c53761c4b0436c9d546ebe046003f1b3d88f Author: Warner Losh AuthorDate: 2024-02-16 03:53:55 +0000 Commit: Warner Losh CommitDate: 2024-02-16 03:59:23 +0000 loader: Move gfx functions to gfx.lua.8 Now that the fb_* and term_* functions are available in the gfx table, move the documentation to gfx.lua.8. Add information about backwards compatibility. Sponsored by: Netflix Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D43907 --- stand/lua/Makefile | 1 + stand/lua/gfx.lua.8 | 106 +++++++++++++++++++++++++++++++++++++++++++++++++ stand/lua/loader.lua.8 | 89 ++++++++--------------------------------- 3 files changed, 124 insertions(+), 72 deletions(-) diff --git a/stand/lua/Makefile b/stand/lua/Makefile index e8fa16e6b589..4462a803beef 100644 --- a/stand/lua/Makefile +++ b/stand/lua/Makefile @@ -7,6 +7,7 @@ MAN= loader.conf.lua.5 \ config.lua.8 \ core.lua.8 \ drawer.lua.8 \ + gfx.lua.8 \ hook.lua.8 \ loader.lua.8 \ menu.lua.8 \ diff --git a/stand/lua/gfx.lua.8 b/stand/lua/gfx.lua.8 new file mode 100644 index 000000000000..82d3f90f4af7 --- /dev/null +++ b/stand/lua/gfx.lua.8 @@ -0,0 +1,106 @@ +.\" +.\" Copyright (c) 2024 Netflix, Inc. +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.Dd February 6, 2024 +.Dt GFX.LUA 8 +.Os +.Sh NAME +.Nm gfx.lua +.Nd Fx Lua gfx module +.Sh DESCRIPTION +The built-in graphics related Lua bindings for the +.Fx +boot loaders using the Lua interpreter are available via the +.Ic gfx +table. +.Ss Exported Functions +The following functions are exported in the +.Nm loader +table. +.Bl -tag -width term_putimage +.It Fn fb_bezier x0 y0 x1 y1 x2 y2 width +Draw a bezier curve through the points +.Pq Va x0 , Va y0 , +.Pq Va x1 , Va y1 , +and +.Pq Va x2 , Va y2 +of width +.Va width . +The units are in pixels and have an origin of +.Pq 0 , 0 . +.It Fn fb_drawrect x0 y0 x1 y1 fill +Fill in a rectangle with the pixel +.Va fill +with the corners +.Pq Va x0 , Va y0 +and +.Pq Va x1 , Va y1 . +The units are in pixels and have an origin of +.Pq 0 , 0 . +.It Fn fb_line x0 y0 x1 y1 width +Draw a line from +.Pq Va x0 , Va y0 +to +.Pq Va x1 , Va y1 +with a width of +.Va width . +The units are in pixels and have an origin of +.Pq 0 , 0 . +.It Fn fb_putimage name x0 y0 x1 y1 f +Load the PNG file +.Va name +and place it in the rectangle +with the corners +.Pq Va x0 , Va y0 +and +.Pq Va x1 , Va y1 +and fill with pixel +.Va f . +The units are in pixels and have an origin of +.Pq 0 , 0 . +.It Fn fb_set_pixel x y +Sets the pixel at +.Pq Va x , Va y . +The units are in pixels and have an origin of +.Pq 0 , 0 . +.It Fn term_drawrect x0 y0 x1 y1 +Draw the outline of a rectangle with the text coordinate corners of +.Pq Va x0 , Va y0 +and +.Pq Va x1 , Va y1 . +The units are in character cells and have an origin of +.Pq 1 , 1 . +.It Fn term_putimage name x0 y0 x1 y1 f +Load the PNG file +.Va name +and place it in the rectangle +with the text coordinate corners +.Pq Va x0 , Va y0 +and +.Pq Va x1 , Va y1 +and fill with pixel +.Va f . +The units are in character cells and have an origin of +.Pq 1 , 1 . +.El +.Pp +This table is optional and should only be used if it is non-nil and if +.Fn core.isFramebufferConsole +is true. +.Ss Compatibility +All the interfaces described above are also available via the +.Ic loader +table through at last FreeBSD 15.0. +.Sh SEE ALSO +.Xr loader.conf 5 , +.Xr core.lua 8 , +.Xr loader 8 , +.Xr loader.lua 8 +.Sh AUTHORS +The +.Nm +man page was written by +.An Warner Losh Aq Mt imp@FreeBSD.org . + diff --git a/stand/lua/loader.lua.8 b/stand/lua/loader.lua.8 index cd436255d4a5..ff3b91ddfb09 100644 --- a/stand/lua/loader.lua.8 +++ b/stand/lua/loader.lua.8 @@ -147,80 +147,24 @@ environments. Removes the environment variable .Va name from the loader's environment list. -.It Fn fb_bezier x0 y0 x1 y1 x2 y2 width -Draw a bezier curve through the points -.Pq Va x0 , Va y0 , -.Pq Va x1 , Va y1 , -and -.Pq Va x2 , Va y2 -of width -.Va width . -The units are in pixels and have an origin of -.Pq 0 , 0 . -.It Fn fb_drawrect x0 y0 x1 y1 fill -Fill in a rectangle with the pixel -.Va fill -with the corners -.Pq Va x0 , Va y0 -and -.Pq Va x1 , Va y1 . -The units are in pixels and have an origin of -.Pq 0 , 0 . -.It Fn fb_line x0 y0 x1 y1 width -Draw a line from -.Pq Va x0 , Va y0 -to -.Pq Va x1 , Va y1 -with a width of -.Va width . -The units are in pixels and have an origin of -.Pq 0 , 0 . -.It Fn fb_putimage name x0 y0 x1 y1 f -Load the PNG file -.Va name -and place it in the rectangle -with the corners -.Pq Va x0 , Va y0 -and -.Pq Va x1 , Va y1 -and fill with pixel -.Va f . -The units are in pixels and have an origin of -.Pq 0 , 0 . -.It Fn fb_set_pixel x y -Sets the pixel at -.Pq Va x , Va y . -The units are in pixels and have an origin of -.Pq 0 , 0 . -.It Fn term_drawrect x0 y0 x1 y1 -Draw the outline of a rectangle with the text coordinate corners of -.Pq Va x0 , Va y0 -and -.Pq Va x1 , Va y1 . -The units are in character cells and have an origin of -.Pq 1 , 1 . -.It Fn term_putimage name x0 y0 x1 y1 f -Load the PNG file -.Va name -and place it in the rectangle -with the text coordinate corners -.Pq Va x0 , Va y0 -and -.Pq Va x1 , Va y1 -and fill with pixel -.Va f . -The units are in character cells and have an origin of -.Pq 1 , 1 . .El -.Pp -The functions starting with -.Fn fb_ +.Ss Compatibility +The functions +.Fn fb_bezier , +.Fn fb_drawrect , +.Fn fb_line , +.Fn fb_putimage , +.Fn fb_set_pixel , +.Fn term_drawrect , and -.Fn term_ -are optional. -They should only be used if they are non-nil and if -.Fn core.isFramebufferConsole -is true. +.Fn term_putimage +have moved to the +.Ic gfx +table. +They remain in the +.Ic loader +table for a transition period and are documented in +.Xr gfx.lua 8 . .Ss Default File In addition, the Lua interpreters start with the file .Pa /boot/lua/loader.lua @@ -231,6 +175,7 @@ If autoboot is enabled, the loaded files will boot. .Sh SEE ALSO .Xr loader.conf 5 , .Xr core.lua 8 , +.Xr gfx.lua 8 , .Xr loader 8 , .Xr sysctl 8 .Sh AUTHORS