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

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

Loading...
Searching...
No Matches
impl.hpp
Go to the documentation of this file.
1
5
6#pragma once
7
8namespace flecs {
9namespace doc {
10
19 inline const char* get_uuid(const flecs::entity_view& e) {
20 return ecs_doc_get_uuid(e.world(), e);
21}
22
31 inline const char* get_name(const flecs::entity_view& e) {
32 return ecs_doc_get_name(e.world(), e);
33}
34
43 inline const char* get_brief(const flecs::entity_view& e) {
44 return ecs_doc_get_brief(e.world(), e);
45}
46
55 inline const char* get_detail(const flecs::entity_view& e) {
56 return ecs_doc_get_detail(e.world(), e);
57}
58
67 inline const char* get_link(const flecs::entity_view& e) {
68 return ecs_doc_get_link(e.world(), e);
69}
70
79 inline const char* get_color(const flecs::entity_view& e) {
80 return ecs_doc_get_color(e.world(), e);
81}
82
91 inline void set_uuid(flecs::entity& e, const char *uuid) {
92 ecs_doc_set_uuid(e.world(), e, uuid);
93}
94
103 inline void set_name(flecs::entity& e, const char *name) {
104 ecs_doc_set_name(e.world(), e, name);
105}
106
115 inline void set_brief(flecs::entity& e, const char *description) {
116 ecs_doc_set_brief(e.world(), e, description);
117}
118
127 inline void set_detail(flecs::entity& e, const char *description) {
128 ecs_doc_set_detail(e.world(), e, description);
129}
130
139 inline void set_link(flecs::entity& e, const char *link) {
140 ecs_doc_set_link(e.world(), e, link);
141}
142
151 inline void set_color(flecs::entity& e, const char *color) {
152 ecs_doc_set_color(e.world(), e, color);
153}
154
156namespace _ {
157
159inline void init(flecs::world& world) {
160 world.component<doc::Description>("flecs::doc::Description");
161}
162
163} // namespace _
164} // namespace doc
165} // namespace flecs
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_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.
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.
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.
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.
flecs::doc::get_color
const char * get_color(const flecs::entity_view &e)
Get color for an entity.
Definition impl.hpp:79
flecs::doc::set_uuid
void set_uuid(flecs::entity &e, const char *uuid)
Set UUID for an entity.
Definition impl.hpp:91
flecs::doc::set_link
void set_link(flecs::entity &e, const char *link)
Set link to external documentation for an entity.
Definition impl.hpp:139
flecs::doc::set_name
void set_name(flecs::entity &e, const char *name)
Set human readable name for an entity.
Definition impl.hpp:103
flecs::doc::get_brief
const char * get_brief(const flecs::entity_view &e)
Get brief description for an entity.
Definition impl.hpp:43
flecs::doc::get_detail
const char * get_detail(const flecs::entity_view &e)
Get detailed description for an entity.
Definition impl.hpp:55
flecs::doc::set_brief
void set_brief(flecs::entity &e, const char *description)
Set brief description for an entity.
Definition impl.hpp:115
flecs::doc::get_link
const char * get_link(const flecs::entity_view &e)
Get link to external documentation for an entity.
Definition impl.hpp:67
flecs::doc::get_name
const char * get_name(const flecs::entity_view &e)
Get human readable name for an entity.
Definition impl.hpp:31
flecs::doc::set_color
void set_color(flecs::entity &e, const char *color)
Set color for an entity.
Definition impl.hpp:151
flecs::doc::Description
EcsDocDescription Description
flecs.doc.Description component
Definition decl.hpp:20
flecs::doc::get_uuid
const char * get_uuid(const flecs::entity_view &e)
Get UUID for an entity.
Definition impl.hpp:19
flecs::doc::set_detail
void set_detail(flecs::entity &e, const char *description)
Set detailed description for an entity.
Definition impl.hpp:127
flecs::world::component
flecs::component< T > component(Args &&... args) const
Find or register component.
Definition impl.hpp:11
flecs::_
Int to enum.
Definition component.hpp:18
flecs::entity_view
Entity view.
Definition entity_view.hpp:28
flecs::entity
Entity.
Definition entity.hpp:30
flecs::world
The world.
Definition world.hpp:150