qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2024-11-24 05:11:42 +00:00
Code Issues Projects Releases Packages Wiki Activity
quakeforge/include/QF/ui/canvas.h

124 lines
3.1 KiB
C
Raw Normal View History

[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
/*
canvas.h
Integration of 2d and 3d objects
Copyright (C) 2022 Bill Currie <bill@taniwha.org>
Author: Bill Currie <bill@taniwha.org>
Date: 2022/12/12
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to:
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
*/
#ifndef __QF_scene_canvas_h
#define __QF_scene_canvas_h
#include "QF/ecs.h"
[ui] Add a function to create a new canvas entity The entity has only a canvas component and (root) view component attached. The plan is to use it for screen-space canvases.
2023-01-20 06:57:29 +00:00
#include "QF/ui/view.h"
[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
enum {
canvas_update,
canvas_updateonce,
canvas_tile,
canvas_pic,
[renderer] Add fitted pic rendering The pic is scaled to fill the specified rect (then clipped to the screen (effectively)). Done just for the console background for now, but it will be used for slice-pics as well. Not implemented for vulkan yet as I'm still thinking about the descriptor management needed for the instanced rendering. Making the conback rendering conditional gave an approximately 3% speed boost to glsl with the GL stub (~12200fps to ~12550fps), for either conback render method.
2023-01-17 02:33:47 +00:00
canvas_fitpic, // pic is scaled to fit the view
[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
canvas_subpic,
canvas_cachepic,
canvas_fill,
canvas_charbuff,
[ui] Add font text drawing to canvas Both passage and simple text are supported, but only simple text has been tested at this stage. However, as passage text was taken directly from rua_gui.c and formed the basis for simple text rendering, I expect it's at least close to working.
2023-07-01 10:49:49 +00:00
canvas_passage_glyphs, // copy of text_passage_glyphs
canvas_glyphs, // copy of text_passage_glyphs
[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
canvas_func,
canvas_outline,
[ui] Add a lateupdate component to canvas Like update, the function takes just a view, but is useful for updates that need to run after the other components are run.
2023-01-21 18:43:58 +00:00
canvas_lateupdate,
[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
// last so deleting an entity removes the grouped components first
canvas_canvas,
canvas_comp_count
};
typedef struct canvas_s {
[ui] Add visibility control to canvases
2023-07-01 10:53:26 +00:00
bool visible;
[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
uint32_t range[canvas_comp_count];
} canvas_t;
extern const struct component_s canvas_components[canvas_comp_count];
typedef struct canvas_system_s {
ecs_registry_t *reg;
[ui] Clean up the canvas component It turns out only the range ids are needed in the canvas component at this stage, and moving the canvas system base into canvas_system_t makes sense.
2022-12-20 16:54:10 +00:00
uint32_t base;
[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
uint32_t view_base;
[ui] Get canvas into a usable state Canvas_SortComponentPool now takes the raw canvas component id as it is specialized to the canvas subpools. Canvas_SetLen resizes the root view and then updates the hierarchy for every canvas in the system. Canvas_InitSys sets up the component system with the systems it needs (canvas, view, text). This is required to ensure view_href is just past the canvas components as it is needed for retrieving the actual canvas component (and thus sub-pool range ids) from arbitrary views in the canvas. Entities are fetched with the correct offset from the pool entities.
2023-01-20 18:26:02 +00:00
uint32_t text_base;
[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
} canvas_system_t;
struct view_s;
struct view_pos_s;
typedef void (*canvas_update_f) (struct view_s);
typedef void (*canvas_func_f) (struct view_pos_s, struct view_pos_s);
typedef struct canvas_subpic_s {
struct qpic_s *pic;
uint32_t x, y;
uint32_t w, h;
} canvas_subpic_t;
[ui] Add a function to create a new canvas entity The entity has only a canvas component and (root) view component attached. The plan is to use it for screen-space canvases.
2023-01-20 06:57:29 +00:00
#define CANVASINLINE GNU89INLINE inline
[ui] Get canvas into a usable state Canvas_SortComponentPool now takes the raw canvas component id as it is specialized to the canvas subpools. Canvas_SetLen resizes the root view and then updates the hierarchy for every canvas in the system. Canvas_InitSys sets up the component system with the systems it needs (canvas, view, text). This is required to ensure view_href is just past the canvas components as it is needed for retrieving the actual canvas component (and thus sub-pool range ids) from arbitrary views in the canvas. Entities are fetched with the correct offset from the pool entities.
2023-01-20 18:26:02 +00:00
void Canvas_InitSys (canvas_system_t *canvas_sys, ecs_registry_t *reg);
[ui] Clean up the canvas component It turns out only the range ids are needed in the canvas component at this stage, and moving the canvas system base into canvas_system_t makes sense.
2022-12-20 16:54:10 +00:00
void Canvas_AddToEntity (canvas_system_t canvas_sys, uint32_t ent);
[ui] Add a function to create a new canvas entity The entity has only a canvas component and (root) view component attached. The plan is to use it for screen-space canvases.
2023-01-20 06:57:29 +00:00
uint32_t Canvas_New (canvas_system_t canvas_sys);
[ui] Clean up the canvas component It turns out only the range ids are needed in the canvas component at this stage, and moving the canvas system base into canvas_system_t makes sense.
2022-12-20 16:54:10 +00:00
void Canvas_Draw (canvas_system_t canvas_sys);
[ecs] Support sorting subpools Sorting the whole pool when subpools are in use could break the subpools (very high probability, depending on the sort criteria and subpool criteria).
2023-01-16 02:32:12 +00:00
void Canvas_SortComponentPool (canvas_system_t canvas_sys, uint32_t ent,
uint32_t component);
[ui] Get canvas into a usable state Canvas_SortComponentPool now takes the raw canvas component id as it is specialized to the canvas subpools. Canvas_SetLen resizes the root view and then updates the hierarchy for every canvas in the system. Canvas_InitSys sets up the component system with the systems it needs (canvas, view, text). This is required to ensure view_href is just past the canvas components as it is needed for retrieving the actual canvas component (and thus sub-pool range ids) from arbitrary views in the canvas. Entities are fetched with the correct offset from the pool entities.
2023-01-20 18:26:02 +00:00
void Canvas_SetLen (canvas_system_t canvas_sys, view_pos_t len);
[ui] Add a function to create a new canvas entity The entity has only a canvas component and (root) view component attached. The plan is to use it for screen-space canvases.
2023-01-20 06:57:29 +00:00
CANVASINLINE view_t Canvas_GetRootView (canvas_system_t canvas_sys,
uint32_t ent);
[ui] Add visibility control to canvases
2023-07-01 10:53:26 +00:00
CANVASINLINE bool *Canvas_Visible (canvas_system_t canvas_sys, uint32_t ent);
[ui] Add a function to create a new canvas entity The entity has only a canvas component and (root) view component attached. The plan is to use it for screen-space canvases.
2023-01-20 06:57:29 +00:00
#undef CANVASINLINE
#ifndef IMPLEMENT_CANVAS_Funcs
#define CANVASINLINE GNU89INLINE inline
#else
#define CANVASINLINE VISIBLE
#endif
CANVASINLINE
view_t
Canvas_GetRootView (canvas_system_t canvas_sys, uint32_t ent)
{
ecs_system_t viewsys = { canvas_sys.reg, canvas_sys.view_base };
return View_FromEntity (viewsys, ent);
}
[ui] Add visibility control to canvases
2023-07-01 10:53:26 +00:00
CANVASINLINE
bool *
Canvas_Visible (canvas_system_t canvas_sys, uint32_t ent)
{
uint32_t comp = canvas_sys.base + canvas_canvas;
return Ent_GetComponent (ent, comp, canvas_sys.reg);
}
[ui] Add a function to create a new canvas entity The entity has only a canvas component and (root) view component attached. The plan is to use it for screen-space canvases.
2023-01-20 06:57:29 +00:00
#undef CANVASINLINE
[ui] Add a canvas system This is the beginning of supporting 2d rendering in 3d space. The idea is that a canvas can be in 2d orthographic space (not attached to any entity with a 3d transform), or in 3d perspective space (attached to an entity with a 3d transform, either as a child of the camera, or of some object in 3d space). It will replace the current HUD code when it's working.
2022-12-20 10:45:48 +00:00
#endif//__QF_scene_canvas_h
Reference in a new issue Copy permalink