Skip to content
This repository has been archived by the owner on Dec 5, 2020. It is now read-only.

Commit

Permalink
docs: Use ImGui capitalization consistently
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
PatchMixolydic committed Jan 11, 2019
1 parent dcce45d commit e03f69c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions include/blackcomb/imgui/Wrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

namespace blackcomb::imgui {
/**
* A conveniece wrapper for Dear IMGUI's initialization and destruction.
* A conveniece wrapper for Dear ImGui's initialization and destruction.
*
* For additional documentation on Dear IMGUI, see https://github.com/ocornut/imgui/wiki.
* For additional documentation on Dear ImGui, see https://github.com/ocornut/imgui/wiki.
*/
class Wrapper {
public:
Expand Down
8 changes: 4 additions & 4 deletions src/imgui/Wrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace blackcomb::imgui {
}

/**
* Initialize the imgui context and bindings. Call after createContext and after configuring ImGui
* Initialize the ImGui context and bindings. Call after createContext and after configuring ImGui
* @param windowPtr The handle of the window to draw to
* @param glslVersion The GLSL version, defined as in a shader file (ie. "#version 150"), or nullptr for imgui's default.
* @param installCallbacks Whether or not imgui should register its callbacks with OpenGL.
Expand All @@ -46,7 +46,7 @@ namespace blackcomb::imgui {

/**
* Should be called each frame you are drawing an imgui object, before rendering anything.
* Informs imgui that a new frame has begun.
* Informs ImGui that a new frame has begun.
*/
void Wrapper::beginFrame() {
// Start the Dear ImGui frame
Expand All @@ -56,7 +56,7 @@ namespace blackcomb::imgui {
}

/**
* Should be called when you are done drawing all of your imgui objects.
* Should be called when you are done drawing all of your ImGui objects.
* Draws the UI to the screen.
*/
void Wrapper::render() {
Expand All @@ -75,7 +75,7 @@ namespace blackcomb::imgui {
}

/**
* Should be called when you are done with imgui, probably in AppBase::destroy.
* Should be called when you are done with ImGui, probably in AppBase::destroy.
*/
void Wrapper::destroy() {
ImGui_ImplOpenGL3_Shutdown();
Expand Down

0 comments on commit e03f69c

Please sign in to comment.