diff options
Diffstat (limited to 'src/libui_sdl/libui/doc')
| -rw-r--r-- | src/libui_sdl/libui/doc/area.md | 53 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/areahandler | 1 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/draw.md | 42 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/drawtext | 13 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/export/coretext | 5 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/form | 1 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/main | 1 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/mainsteps | 1 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/slider | 1 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/spinbox | 1 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/static | 2 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/windowmovesize | 3 | ||||
| -rw-r--r-- | src/libui_sdl/libui/doc/winstatic | 1 |
13 files changed, 0 insertions, 125 deletions
diff --git a/src/libui_sdl/libui/doc/area.md b/src/libui_sdl/libui/doc/area.md deleted file mode 100644 index d14be9c..0000000 --- a/src/libui_sdl/libui/doc/area.md +++ /dev/null @@ -1,53 +0,0 @@ -# uiArea - -uiArea is a uiControl that provides a canvas you can draw on. It receives keyboard and mouse events, supports scrolling, is DPI aware, and has several other useful features. A uiArea consists of the drawing area itself and horizontal and vertical scrollbars. - -## The Area Handler - -A uiArea is driven by an *area handler*. An area handler is an object with several methods that uiArea calls to do certain tasks. To create an area handler, simply have a structure whose first member is of type `uiAreaHandler`: - -```c -struct uiAreaHandler { - void (*Draw)(uiAreaHandler *h, uiArea *a, uiAreaDrawParams *p); - void (*HScrollConfig)(uiAreaHandler *h, uiArea *a, uiAreaScrollConfig *c); - void (*VScrollConfig)(uiAreaHandler *h, uiArea *a, uiAreaScrollConfig *c); -} -``` - -## Drawing - -Unlike drawing canvas controls in other toolkits, uiArea does **not** have a fixed size. The coordinate (0, 0) is always the top-left corner of the drawing area, regardless of how big the uiArea is in the current window or where the scrollbars presently are. Instead, you simulate a size by setting the scrollbar bounds, and you are given the current scrolling positions to base your drawing with. - -The visible drawing area is called the *content area* by the drawing machinery. - -TODO have a diagram. - -When a part of the uiArea needs to be redrawn, the area handler's `Draw()` method is called. It receives the area handler, the uiArea, and a structure of parameters necessary for drawing. - -```c -struct uiAreaDrawParams { - uiDrawContext *context; - - intmax_t contentWidth; - intmax_t contentHeight; - - intmax_t hscrollpos; - intmax_t vscrollpos; - - intmax_t clipX; - intmax_t cilpY; - intmax_t clipWidth; - intmax_t clipHeight; - - TODO dpiX; - TODO dpiY; -}; -``` - -`context` is the drawing context; see drawing.md for details. - -`contentWidth` and `contentHeight` is the current width and height of the content area. `hscrollpos` and `vscrollpos` are the current horizontal and vertical positions of the scrollbars, in units defined by the scrollbar configurations; see below. - -`clipX`, `clipY`, `clipWidth`, and `clipHeight` define a rectangle, in content area coordinates, that the OS has requested to be redrawn. You can use this to optimize your drawing by only drawing where drawing is needed; the OS may choose to drop any drawing done outside the clip rectangle. - -`dpiX` and `dpiY` are the uiArea's current DPI in the X and Y directions, respectively. Do not save these values; they are not guaranteed to stay the same once `Draw()` returns. diff --git a/src/libui_sdl/libui/doc/areahandler b/src/libui_sdl/libui/doc/areahandler deleted file mode 100644 index 4c559db..0000000 --- a/src/libui_sdl/libui/doc/areahandler +++ /dev/null @@ -1 +0,0 @@ -Yes, you keep ownership of the uiAreaHandler. libui only cares about the address you give uiNewArea(); it doesn't copy anything. You can even use the same uiAreaHandler on multiple uiAreas, which is why you get the uiArea as a parameter in each function. diff --git a/src/libui_sdl/libui/doc/draw.md b/src/libui_sdl/libui/doc/draw.md deleted file mode 100644 index ef849fd..0000000 --- a/src/libui_sdl/libui/doc/draw.md +++ /dev/null @@ -1,42 +0,0 @@ -# The Drawing Model - -> Note: This model is not exclusive to libui; it is also applicable to many 2D graphics libraries, such as Direct2D, cairo, and Core Graphics. - -## The Coordinate System and Points - -In the traditional way we think of drawing, we think of rendering onto a plane of pixels. The pixels have a fixed size, and coordinates refer to the entire space that a pixel occupies. - -For instance, in the traditional model, the coordinate system looks like - -TODO image - -and when we say "draw a line from (0, 0) to (5, 5) exclusive", we mean "fill the spaces that are occupied by the pixels at (0, 0), (1, 1), (2, 2), (3, 3), and (4, 4)": - -TODO image - -Ugh. With pixels as big as the ones TODO. - -But now let's pretend we're working in a coordinate system where the point at (x, y) corresponds strictly to the top-left corner of the area that a pixel occupies. - -TODO image - -In this model, when we say "draw a line from (0, 0) to (5, 5)", we mean "draw a straight line filling every pixel that we cross if we traced a line from the top-left corner of what we used to call the pixel at (0, 0 to the top-left corner of what we used to call the pixel at (5, 5)": - -TODO image - -TODO. - -There are both technical and non-technical reasons for following this model. The technical reason is that implementing certain drawing operations, such as filling shapes, is much easier if we do things this way. The [cairo FAQ](http://www.cairographics.org/FAQ/#sharp_lines) explains in more detail. The non-technical reason has to do with DPI independence. - -## DPI Independence vs. DPI Awareness - -An upcoming trend in computing is the high-resolution display. These displays fit more dots in the same area that older screens could. The conventional term for the number of dots that fit in a given area is the "dots per inch", or DPI, measure. - -A naive approach to writing programs for these new displays is to think "well, if I just take the DPI and only use it in calculations where I need to deal with real-world measurements such as inches, rendering pure pixels as I always have, I should be fine". This kind of design is centered around *DPI awareness*. I know, I used to believe this too. But here's a little secret: this is wrong! A common myth about high-resolution monitors among non-technical people is that it makes the stuff on screen smaller. The mindset I just described causes this: TODO - -Instead, what we want out of a high-resolution display is *to show a more detailed view of the same image in the same space*. [The first image on Apple''s discussion of the topic](https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Art/backing_store_2x.png) is the perfect example. On the left, you see a low-resolution monitor. Notice how big chunks of the shapes go into the boxes. When the code that maps points to pixels runs, it can't have two colors in one square, so it has to decide what color to use. TODO - -TODO -- talk about how this relates to the OpenGL unit cube -- talk about the various names (point, user space coordinate, device-independent pixel) -- talk about "scaling" diff --git a/src/libui_sdl/libui/doc/drawtext b/src/libui_sdl/libui/doc/drawtext deleted file mode 100644 index 9d37713..0000000 --- a/src/libui_sdl/libui/doc/drawtext +++ /dev/null @@ -1,13 +0,0 @@ -on some unix systems, alpha blending fonts may not be available; this depends on your installed version of pango and is determined at runtime by libui - -uiDrawTextLayoutExtents: document that the extent width can be greater than the requested width if the requested width is small enough that only one character can fit - - -font matching is closest match but the search method is OS defined - - -weight names in libui do not necessarily line up with their OS names - - -uiDrawFontHandle() may not return a unique handle per instance - diff --git a/src/libui_sdl/libui/doc/export/coretext b/src/libui_sdl/libui/doc/export/coretext deleted file mode 100644 index 0888383..0000000 --- a/src/libui_sdl/libui/doc/export/coretext +++ /dev/null @@ -1,5 +0,0 @@ -font features are not provided by the collection and have to be added when asking for a font -it does preserve when going from CTFont to CTFontDescriptor -feature 17 has no flags in the header but can also hold small caps info -if a feature is present, it is ignored; other features will still show up - at least in the case of kLetterCaseTrait and kLowerCaseTrait diff --git a/src/libui_sdl/libui/doc/form b/src/libui_sdl/libui/doc/form deleted file mode 100644 index f24a94d..0000000 --- a/src/libui_sdl/libui/doc/form +++ /dev/null @@ -1 +0,0 @@ -hiding a control also hides its label diff --git a/src/libui_sdl/libui/doc/main b/src/libui_sdl/libui/doc/main deleted file mode 100644 index 9fa9c36..0000000 --- a/src/libui_sdl/libui/doc/main +++ /dev/null @@ -1 +0,0 @@ -after uiQuit or if uiShouldQuit returns nonzero, uiQueueMain's effect is undefined diff --git a/src/libui_sdl/libui/doc/mainsteps b/src/libui_sdl/libui/doc/mainsteps deleted file mode 100644 index f572b21..0000000 --- a/src/libui_sdl/libui/doc/mainsteps +++ /dev/null @@ -1 +0,0 @@ -the function passed to mainsteps must not return until uiQuit itself has been called; otherwise the results are undefined diff --git a/src/libui_sdl/libui/doc/slider b/src/libui_sdl/libui/doc/slider deleted file mode 100644 index 5a6ac04..0000000 --- a/src/libui_sdl/libui/doc/slider +++ /dev/null @@ -1 +0,0 @@ -if min >= max then they are swapped diff --git a/src/libui_sdl/libui/doc/spinbox b/src/libui_sdl/libui/doc/spinbox deleted file mode 100644 index 5a6ac04..0000000 --- a/src/libui_sdl/libui/doc/spinbox +++ /dev/null @@ -1 +0,0 @@ -if min >= max then they are swapped diff --git a/src/libui_sdl/libui/doc/static b/src/libui_sdl/libui/doc/static deleted file mode 100644 index fe1a09c..0000000 --- a/src/libui_sdl/libui/doc/static +++ /dev/null @@ -1,2 +0,0 @@ -comctl6 -libui.res diff --git a/src/libui_sdl/libui/doc/windowmovesize b/src/libui_sdl/libui/doc/windowmovesize deleted file mode 100644 index ec8bd96..0000000 --- a/src/libui_sdl/libui/doc/windowmovesize +++ /dev/null @@ -1,3 +0,0 @@ -you should never need to use these functions -they are provided only for the cases when ABSOLUTELY NECESSARY -the operating system may ignore your requests, for instance, if you are giving it invalid numbers or a size too small to fit; this is all system-defined diff --git a/src/libui_sdl/libui/doc/winstatic b/src/libui_sdl/libui/doc/winstatic deleted file mode 100644 index 5f163cf..0000000 --- a/src/libui_sdl/libui/doc/winstatic +++ /dev/null @@ -1 +0,0 @@ -libui uses resources starting at 29000 |