blob: f865f6760ba78987e1f602ce9997ce017bf0eb64 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
---
title: Naming Conventions
---
#### 1. Prefer SOV function names
Prefer SOV Subject Object Verb naming for functions.
This makes it very easy to find the functions you want with autocomplete and maintain a consistent naming convention
throughout the codebase.
e.g.
* `renderer_frame_begin`
* `engine_tick_begin`
* `texture_data_load`
---
#### 2. Long-running systems
in celeritas a "system" is roughly something that runs every frame
systems that run for the lifetime of the application or for a very long time should have:
* `bool system_init(system_state* state)` a `init` function
* `void system_shutdown(system_state* state)` and a `shutdown` function
---
#### 3. TODO
|
