Flecs v4.0
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
doc.h
Go to the documentation of this file.
1
11#ifdef FLECS_DOC
12
13#ifndef FLECS_DOC_H
14#define FLECS_DOC_H
15
16#ifndef FLECS_MODULE
17#define FLECS_MODULE
18#endif
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
32FLECS_API extern const ecs_entity_t ecs_id(EcsDocDescription);
37FLECS_API extern const ecs_entity_t EcsDocBrief;
38
42FLECS_API extern const ecs_entity_t EcsDocDetail;
43
47FLECS_API extern const ecs_entity_t EcsDocLink;
48
52FLECS_API extern const ecs_entity_t EcsDocColor;
53
62typedef struct EcsDocDescription {
63 char *value;
65
78FLECS_API
80 ecs_world_t *world,
81 ecs_entity_t entity,
82 const char *name);
83
94FLECS_API
96 ecs_world_t *world,
97 ecs_entity_t entity,
98 const char *description);
99
110FLECS_API
112 ecs_world_t *world,
113 ecs_entity_t entity,
114 const char *description);
115
126FLECS_API
128 ecs_world_t *world,
129 ecs_entity_t entity,
130 const char *link);
131
143FLECS_API
145 ecs_world_t *world,
146 ecs_entity_t entity,
147 const char *color);
148
173FLECS_API
175 const ecs_world_t *world,
176 ecs_entity_t entity);
177
188FLECS_API
190 const ecs_world_t *world,
191 ecs_entity_t entity);
192
203FLECS_API
205 const ecs_world_t *world,
206 ecs_entity_t entity);
207
218FLECS_API
220 const ecs_world_t *world,
221 ecs_entity_t entity);
222
233FLECS_API
235 const ecs_world_t *world,
236 ecs_entity_t entity);
237
246FLECS_API
248 ecs_world_t *world);
249
252#ifdef __cplusplus
253}
254#endif
255
256#endif
257
258#endif
FLECS_API const ecs_entity_t ecs_id(EcsDocDescription)
Component id for EcsDocDescription.
FLECS_API const ecs_entity_t EcsDocDetail
Tag for adding detailed descriptions to entities.
FLECS_API const ecs_entity_t EcsDocLink
Tag for adding a link to entities.
FLECS_API const char * ecs_doc_get_name(const ecs_world_t *world, ecs_entity_t entity)
Get human readable name from entity.
FLECS_API const ecs_entity_t EcsDocColor
Tag for adding a color to entities.
FLECS_API const char * ecs_doc_get_color(const ecs_world_t *world, ecs_entity_t entity)
Get color from entity.
FLECS_API void ecs_doc_set_brief(ecs_world_t *world, ecs_entity_t entity, const char *description)
Add brief description to entity.
struct EcsDocDescription EcsDocDescription
Component that stores description.
FLECS_API const char * ecs_doc_get_link(const ecs_world_t *world, ecs_entity_t entity)
Get link to external documentation from entity.
FLECS_API const char * ecs_doc_get_detail(const ecs_world_t *world, ecs_entity_t entity)
Get detailed description from entity.
FLECS_API const char * ecs_doc_get_brief(const ecs_world_t *world, ecs_entity_t entity)
Get brief description from entity.
FLECS_API void ecs_doc_set_detail(ecs_world_t *world, ecs_entity_t entity, const char *description)
Add detailed description to entity.
FLECS_API const ecs_entity_t EcsDocBrief
Tag for adding brief descriptions to entities.
FLECS_API void ecs_doc_set_link(ecs_world_t *world, ecs_entity_t entity, const char *link)
Add link to external documentation to entity.
FLECS_API void ecs_doc_set_color(ecs_world_t *world, ecs_entity_t entity, const char *color)
Add color to entity.
FLECS_API void ecs_doc_set_name(ecs_world_t *world, ecs_entity_t entity, const char *name)
Add human-readable name to entity.
FLECS_API void FlecsDocImport(ecs_world_t *world)
Doc module import function.
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:339
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:383
Component that stores description.
Definition doc.h:62