Skip to content

Commit

Permalink
LevelCelView: add documentation
Browse files Browse the repository at this point in the history
This patch adds documentation for LevelCelView's newly dded
function - checkImageType.
  • Loading branch information
tetektoza committed Aug 3, 2024
1 parent 962441a commit 8d24b1f
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions source/views/levelcelview.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,13 @@ void LevelCelView::update()
this->tabFrameWidget->initialize(this, this->gfx);
}

/**
* @brief Checks in which image type the coordinates are currently in
*
* This function accepts coordinates and checks, based on them in which
* image type (frame, tile or megatile), the coordinates are currently in.
* This is currently useful for knowing where exactly user's cursor is.
*/
IMAGE_TYPE LevelCelView::checkImageType(unsigned x, unsigned y)
{
unsigned celFrameWidth = MICRO_WIDTH; // this->gfx->getFrameWidth(this->currentFrameIndex);
Expand Down

0 comments on commit 8d24b1f

Please sign in to comment.