Flecs: include/flecs/addons/doc.h Source File
Description: A fast entity component system (ECS) for C & C++

| Flecs v4.1 A fast entity component system (ECS) for C & C++

Loading...
Searching...
No Matches
doc.h
Go to the documentation of this file.
1
10
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
31
32FLECS_API extern const ecs_entity_t ecs_id(EcsDocDescription);
33
37FLECS_API extern const ecs_entity_t EcsDocUuid;
38
42FLECS_API extern const ecs_entity_t EcsDocBrief;
43
47FLECS_API extern const ecs_entity_t EcsDocDetail;
48
52FLECS_API extern const ecs_entity_t EcsDocLink;
53
57FLECS_API extern const ecs_entity_t EcsDocColor;
58
67 typedef struct EcsDocDescription {
68 char *value;
69} EcsDocDescription;
70
82FLECS_API
83 void ecs_doc_set_uuid(
84 ecs_world_t *world,
85 ecs_entity_t entity,
86 const char *uuid);
87
100FLECS_API
101 void ecs_doc_set_name(
102 ecs_world_t *world,
103 ecs_entity_t entity,
104 const char *name);
105
116FLECS_API
117 void ecs_doc_set_brief(
118 ecs_world_t *world,
119 ecs_entity_t entity,
120 const char *description);
121
132FLECS_API
133 void ecs_doc_set_detail(
134 ecs_world_t *world,
135 ecs_entity_t entity,
136 const char *description);
137
148FLECS_API
149 void ecs_doc_set_link(
150 ecs_world_t *world,
151 ecs_entity_t entity,
152 const char *link);
153
165FLECS_API
166 void ecs_doc_set_color(
167 ecs_world_t *world,
168 ecs_entity_t entity,
169 const char *color);
170
180FLECS_API
181 const char* ecs_doc_get_uuid(
182 const ecs_world_t *world,
183 ecs_entity_t entity);
184
209FLECS_API
210 const char* ecs_doc_get_name(
211 const ecs_world_t *world,
212 ecs_entity_t entity);
213
224FLECS_API
225 const char* ecs_doc_get_brief(
226 const ecs_world_t *world,
227 ecs_entity_t entity);
228
239FLECS_API
240 const char* ecs_doc_get_detail(
241 const ecs_world_t *world,
242 ecs_entity_t entity);
243
254FLECS_API
255 const char* ecs_doc_get_link(
256 const ecs_world_t *world,
257 ecs_entity_t entity);
258
269FLECS_API
270 const char* ecs_doc_get_color(
271 const ecs_world_t *world,
272 ecs_entity_t entity);
273
282FLECS_API
283 void FlecsDocImport(
284 ecs_world_t *world);
285
287
288#ifdef __cplusplus
289}
290#endif
291
292#endif
293
294#endif
ecs_doc_set_uuid
FLECS_API void ecs_doc_set_uuid(ecs_world_t *world, ecs_entity_t entity, const char *uuid)
Add UUID to entity.
ecs_id
FLECS_API const ecs_entity_t ecs_id(EcsDocDescription)
Component ID for EcsDocDescription.
EcsDocDetail
FLECS_API const ecs_entity_t EcsDocDetail
Tag for adding detailed descriptions to entities.
EcsDocLink
FLECS_API const ecs_entity_t EcsDocLink
Tag for adding a link to entities.
ecs_doc_get_name
FLECS_API const char * ecs_doc_get_name(const ecs_world_t *world, ecs_entity_t entity)
Get human-readable name from entity.
EcsDocColor
FLECS_API const ecs_entity_t EcsDocColor
Tag for adding a color to entities.
ecs_doc_get_color
FLECS_API const char * ecs_doc_get_color(const ecs_world_t *world, ecs_entity_t entity)
Get color from entity.
ecs_doc_get_uuid
FLECS_API const char * ecs_doc_get_uuid(const ecs_world_t *world, ecs_entity_t entity)
Get UUID from entity.
ecs_doc_set_brief
FLECS_API void ecs_doc_set_brief(ecs_world_t *world, ecs_entity_t entity, const char *description)
Add brief description to entity.
ecs_doc_get_link
FLECS_API const char * ecs_doc_get_link(const ecs_world_t *world, ecs_entity_t entity)
Get link to external documentation from entity.
ecs_doc_get_detail
FLECS_API const char * ecs_doc_get_detail(const ecs_world_t *world, ecs_entity_t entity)
Get detailed description from entity.
ecs_doc_get_brief
FLECS_API const char * ecs_doc_get_brief(const ecs_world_t *world, ecs_entity_t entity)
Get brief description from entity.
EcsDocUuid
FLECS_API const ecs_entity_t EcsDocUuid
Tag for adding a UUID to entities.
ecs_doc_set_detail
FLECS_API void ecs_doc_set_detail(ecs_world_t *world, ecs_entity_t entity, const char *description)
Add detailed description to entity.
EcsDocBrief
FLECS_API const ecs_entity_t EcsDocBrief
Tag for adding brief descriptions to entities.
ecs_doc_set_link
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.
ecs_doc_set_color
FLECS_API void ecs_doc_set_color(ecs_world_t *world, ecs_entity_t entity, const char *color)
Add color to entity.
ecs_doc_set_name
FLECS_API void ecs_doc_set_name(ecs_world_t *world, ecs_entity_t entity, const char *name)
Add human-readable name to entity.
FlecsDocImport
FLECS_API void FlecsDocImport(ecs_world_t *world)
Doc module import function.
ecs_entity_t
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:381
ecs_world_t
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:425
EcsDocDescription
Component that stores description.
Definition doc.h:67
EcsDocDescription::value
char * value
Description value.
Definition doc.h:68