From 2fc3ff16b8ef1823a45cf445aa70b39d4141404f Mon Sep 17 00:00:00 2001 From: tetektoza Date: Sat, 3 Aug 2024 13:37:46 +0200 Subject: [PATCH] LevelCelView: Add documentation This patch adds documentation for LevelCelView's newly dded function - checkImageType. --- source/views/levelcelview.cpp | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/views/levelcelview.cpp b/source/views/levelcelview.cpp index 4244cf72..802ae8d0 100644 --- a/source/views/levelcelview.cpp +++ b/source/views/levelcelview.cpp @@ -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);