Skip to content

Deprecate awesome.load_image #3976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Delta-official wants to merge 2 commits into
base: master
Choose a base branch
from
+14 −5
Open

Deprecate awesome.load_image #3976

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e71e5de
deprecate awesome.load_image
Delta-official Nov 27, 2024
3f2744c
doc: add `@deprecatedstaticmtd` ldoc tag
Aire-One Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions luaa.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,14 +327,12 @@ luaA_pixbuf_to_surface(lua_State *L)
* @treturn gears.surface A cairo surface as light user datum.
* @treturn nil|string The error message, if any.
* @staticfct load_image
* @deprecated awesome.pixbuf_to_surface
*/
static int
luaA_load_image(lua_State *L)
{
/* TODO: Deprecate this function, Lua can use GdkPixbuf directly plus
* awesome.pixbuf_to_surface
*/

luaA_deprecate(L, "awesome.pixbuf_to_surface");
Copy link
Copy Markdown
Contributor

@sclu1034 sclu1034 Nov 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The suggestion for awesome.pixbuf_to_surface in that comment has since become outdated as well. I think gears.surface would be a better suggestion.

Copy link
Copy Markdown
Author

@Delta-official Delta-official Nov 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gears.surface uses awesome.pixbuf_to_surface internally, and I would argue that it's better to put a function as close to the replaced one in functionality in @deprecate

Copy link
Copy Markdown
Member

@Aire-One Aire-One Dec 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's do it one step at a time, this will do.

GError *error = NULL;
const char *filename = luaL_checkstring(L, 1);
cairo_surface_t *surface = draw_load_image(L, filename, &error);
Expand Down
Loading