edg-l/ddnet
1
0
Fork 0
mirror of https://github.com/ddnet/ddnet.git synced 2024-11-19 22:48:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added a small documentation to the api

Browse source
This commit is contained in:
LordSk 2019-02-02 14:16:46 +01:00
parent 81efacb6cc
commit 48968faeda
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
src/game/client/components/menus.h
View file

@ -201,6 +201,35 @@ private:
} }
}; };
// Scroll region
/*
Usage:
-- Initialization --
static CScrollRegion s_ScrollRegion;
vec2 ScrollOffset(0, 0);
BeginScrollRegion(&s_ScrollRegion, &ScrollRegionRect, &ScrollOffset);
Content = ScrollRegionRect;
Content.y += ScrollOffset.y;
-- "Register" your content rects --
CUIRect Rect;
Content.HSplitTop(SomeValue, &Rect, &Content);
ScrollRegionAddRect(&s_ScrollRegion, Rect);
-- [Optionnal] Knowing if a rect is clipped --
ScrollRegionIsRectClipped(&s_ScrollRegion, Rect);
-- [Optionnal] Scroll to a rect --
...
ScrollRegionAddRect(&s_ScrollRegion, Rect);
ScrollRegionScrollHere(&s_ScrollRegion, Rect, Option);
-- End --
EndScrollRegion(&s_ScrollRegion);
*/
void BeginScrollRegion(CScrollRegion* pSr, CUIRect* pClipRect, vec2* pOutOffset, const CScrollRegionParams* pParams = 0); void BeginScrollRegion(CScrollRegion* pSr, CUIRect* pClipRect, vec2* pOutOffset, const CScrollRegionParams* pParams = 0);
void EndScrollRegion(CScrollRegion* pSr); void EndScrollRegion(CScrollRegion* pSr);
void ScrollRegionAddRect(CScrollRegion* pSr, CUIRect Rect); void ScrollRegionAddRect(CScrollRegion* pSr, CUIRect Rect);