Adds beginnings of the style guide
Refactors file and folder names to conform to the style guidecore_refactor
parent
c7928af683
commit
b42b0c69a0
@ -0,0 +1,10 @@
|
||||
|
||||
|
||||
file and folder names should be all lower-case using underscores to separate words (snake case) (ex: run_mode.h, simple_render_scene.cpp)
|
||||
All variables should be snake case (lower-case with underscores to separate words)
|
||||
All method names should be pascal case (no underscores and each word capitalized ex: GetUserName())
|
||||
All class and struct names should be pascal case (no underscores and each word capitalized ex: GetUserName())
|
||||
|
||||
All methods should be defined in a .cpp (no inline methods in headers)
|
||||
Class member variables should start with m (ex: mUserName)
|
||||
Struct member variables should NOT start with m (ex: UserName)
|
||||
@ -1,6 +1,6 @@
|
||||
|
||||
/******************************************************************************
|
||||
* File - InputManager.h
|
||||
* File - input_manager.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2019/11/14 (y/m/d)
|
||||
* Mod Date - 2021/09/08 (y/m/d)
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - dataManager.h
|
||||
* File - data_manager.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2021/12/01 (y/m/d)
|
||||
* Mod Date - 2021/12/01 (y/m/d)
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - InternalFont.h
|
||||
* File - internal_font.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2020/01/08 (y/m/d)
|
||||
* Mod Date - 2020/01/08 (y/m/d)
|
||||
@ -1,23 +0,0 @@
|
||||
/******************************************************************************
|
||||
* File - definitions.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2021/09/14 (y/m/d)
|
||||
* Mod Date - 2021/09/14 (y/m/d)
|
||||
* Description - Common graphics definitions
|
||||
******************************************************************************/
|
||||
|
||||
#ifndef ASSETS_DEFINITIONS_H_
|
||||
#define ASSETS_DEFINITIONS_H_
|
||||
|
||||
namespace lunarium
|
||||
{
|
||||
enum ImageFormat
|
||||
{
|
||||
RGB,
|
||||
RGBA,
|
||||
BGR,
|
||||
BGRA
|
||||
};
|
||||
}
|
||||
|
||||
#endif // ASSETS_DEFINITIONS_H_
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - KeyCodes.h
|
||||
* File - key_codes.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2019/11/14 (y/m/d)
|
||||
* Mod Date - 2021/09/08 (y/m/d)
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - assetBrowser.h
|
||||
* File - asset_browser.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2021/11/10 (y/m/d)
|
||||
* Mod Date - 2021/11/10 (y/m/d)
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - propertiesView.h
|
||||
* File - properties_view.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2022/01/26 (y/m/d)
|
||||
* Mod Date - 2022/01/26 (y/m/d)
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - worldTree.h
|
||||
* File - world_tree.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2021/11/04 (y/m/d)
|
||||
* Mod Date - 2021/11/04 (y/m/d)
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - worldView.h
|
||||
* File - world_view.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2022/01/26 (y/m/d)
|
||||
* Mod Date - 2022/01/26 (y/m/d)
|
||||
@ -1,12 +1,12 @@
|
||||
/******************************************************************************
|
||||
* File - physicsScene.h
|
||||
* File - physics_scene.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2021/10/27 (y/m/d)
|
||||
* Mod Date - 2021/10/27 (y/m/d)
|
||||
* Description - Displays a scene that tests the Box2D physics system
|
||||
******************************************************************************/
|
||||
|
||||
#include "physicsScene.h"
|
||||
#include "physics_scene.h"
|
||||
#include <core/core.h>
|
||||
#include <graphics/graphics.h>
|
||||
#include <utils/logger.h>
|
||||
@ -1,17 +1,17 @@
|
||||
/******************************************************************************
|
||||
* File - simpleRenderScene.cpp
|
||||
* File - simple_render_scene.cpp
|
||||
* Author - Joey Pollack
|
||||
* Date - 2021/10/27 (y/m/d)
|
||||
* Mod Date - 2021/10/27 (y/m/d)
|
||||
* Description - Displays a simple scene that tests basic render features.
|
||||
******************************************************************************/
|
||||
|
||||
#include "simpleRenderScene.h"
|
||||
#include "simple_render_scene.h"
|
||||
#include <core/core.h>
|
||||
#include <utils/helpers.h>
|
||||
#include <utils/logger.h>
|
||||
#include <graphics/graphics.h>
|
||||
#include <input/inputManager.h>
|
||||
#include <input/input_manager.h>
|
||||
#include <assets/types/image.h>
|
||||
#include <utils/stb/std_image_write.h>
|
||||
#include <utils/stb/stb_image.h>
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - scriptManager.h
|
||||
* File - script_manager.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2021/08/30 (y/m/d)
|
||||
* Mod Date - 2021/09/02 (y/m/d)
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* File - BinaryFileBuffer.h
|
||||
* File - binary_file_buffer.h
|
||||
* Author - Joey Pollack
|
||||
* Date - 2020/01/24 (y/m/d)
|
||||
* Mod Date - 2020/01/24 (y/m/d)
|
||||
@ -1,12 +1,12 @@
|
||||
/******************************************************************************
|
||||
* File - FrameCounter.cpp
|
||||
* File - frame_counter.cpp
|
||||
* Author - Joey Pollack
|
||||
* Date - 2021/09/03 (y/m/d)
|
||||
* Mod Date - 2021/09/03 (y/m/d)
|
||||
* Description - Tracks frame statistics
|
||||
******************************************************************************/
|
||||
|
||||
#include "frameCounter.h"
|
||||
#include "frame_counter.h"
|
||||
#include <cstring>
|
||||
|
||||
namespace lunarium
|
||||
@ -1,5 +1,5 @@
|
||||
/******************************************************************************
|
||||
* Filename: HighResTimer.h
|
||||
* Filename: high_resolution_timer.h
|
||||
* Date: 12/06/2010
|
||||
* Mod. Date: 03/21/2018
|
||||
* Author: Joseph R. Pollack
|
||||
Loading…
Reference in New Issue