mirror of
https://github.com/nicbarker/clay.git
synced 2025-01-23 09:56:03 +00:00
Compare commits
1 Commits
4441b676d2
...
40ca3a379b
Author | SHA1 | Date | |
---|---|---|---|
|
40ca3a379b |
67
README.md
67
README.md
@ -28,31 +28,17 @@ _An example GUI application built with clay_
|
|||||||
#include "clay.h"
|
#include "clay.h"
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Ask clay for how much static memory it needs using [Clay_MinMemorySize()](#clay_minmemorysize), create an Arena for it to use with [Clay_CreateArenaWithCapacityAndMemory(size, void *memory)](#clay_createarenawithcapacityandmemory).
|
2. Ask clay for how much static memory it needs using [Clay_MinMemorySize()](#clay_minmemorysize), create an Arena for it to use with [Clay_CreateArenaWithCapacityAndMemory(size, void *memory)](#clay_createarenawithcapacityandmemory), and initialize it with [Clay_Initialize(arena, dimensions)](#clay_initialize).
|
||||||
|
|
||||||
```C
|
```C
|
||||||
// Note: malloc is only used here as an example, any allocator that provides
|
// Note: malloc is only used here as an example, any allocator that provides
|
||||||
// a pointer to addressable memory of at least totalMemorySize will work
|
// a pointer to addressable memory of at least totalMemorySize will work
|
||||||
uint64_t totalMemorySize = Clay_MinMemorySize();
|
uint64_t totalMemorySize = Clay_MinMemorySize();
|
||||||
Clay_Arena arena = Clay_CreateArenaWithCapacityAndMemory(totalMemorySize, malloc(totalMemorySize));
|
Clay_Arena arena = Clay_CreateArenaWithCapacityAndMemory(totalMemorySize, malloc(totalMemorySize));
|
||||||
|
Clay_Initialize(arena, (Clay_Dimensions) { screenWidth, screenHeight });
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Create an [ErrorHandler](#clay_errorhandler) for Clay to call when an internal error occurs, and initialize Clay with the Arena and handler by calling [Clay_Initialize(arena, dimensions, errorHandler)](#clay_initialize).
|
3. Provide a `MeasureText(text, config)` function pointer with [Clay_SetMeasureTextFunction(function)](#clay_setmeasuretextfunction) so that clay can measure and wrap text.
|
||||||
|
|
||||||
```C
|
|
||||||
void HandleClayErrors(Clay_ErrorData errorData) {
|
|
||||||
// See the Clay_ErrorData struct for more information
|
|
||||||
printf("%s", errorData.errorText.chars);
|
|
||||||
switch(errorData.errorType) {
|
|
||||||
// etc
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// In your startup function
|
|
||||||
Clay_Initialize(arena, (Clay_Dimensions) { screenWidth, screenHeight }, (Clay_ErrorHandler) { HandleClayErrors });
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Provide a `MeasureText(text, config)` function pointer with [Clay_SetMeasureTextFunction(function)](#clay_setmeasuretextfunction) so that clay can measure and wrap text.
|
|
||||||
|
|
||||||
```C
|
```C
|
||||||
// Example measure text function
|
// Example measure text function
|
||||||
@ -825,53 +811,6 @@ An offset version of [CLAY_ID](#clay_id). Generates a [Clay_ElementId](#clay_ele
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### CLAY_ID_LOCAL()
|
|
||||||
|
|
||||||
**Usage**
|
|
||||||
|
|
||||||
`CLAY(CLAY_ID_LOCAL(char* idString)) {}`
|
|
||||||
|
|
||||||
**Lifecycle**
|
|
||||||
|
|
||||||
`Clay_BeginLayout()` -> `CLAY(` -> `CLAY_ID_LOCAL()` -> `)` -> `Clay_EndLayout()`
|
|
||||||
|
|
||||||
**Notes**
|
|
||||||
|
|
||||||
**CLAY_ID_LOCAL()** is used to generate and attach a [Clay_ElementId](#clay_elementid) to a layout element during declaration.
|
|
||||||
|
|
||||||
Unlike [CLAY_ID](#clay_id) which needs to be globally unique, a local ID is based on the ID of it's parent and only needs to be unique among its siblings.
|
|
||||||
|
|
||||||
As a result, local id is suitable for use in reusable components and loops.
|
|
||||||
|
|
||||||
**Examples**
|
|
||||||
|
|
||||||
```C
|
|
||||||
void RenderHeaderButton(ButtonData button) {
|
|
||||||
CLAY(
|
|
||||||
CLAY_ID_LOCAL("HeaderButton"),
|
|
||||||
CLAY_LAYOUT({ .layoutDirection = CLAY_TOP_TO_BOTTOM, .sizing = { .width = CLAY_SIZING_GROW(0) }, .padding = CLAY_PADDING_ALL(16), .childGap = 16) })
|
|
||||||
) {
|
|
||||||
// ...children
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for (int i = 0; i < headerButtons.length; i++) {
|
|
||||||
RenderHeaderButton(headerButtons.items[i]);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CLAY_IDI_LOCAL()
|
|
||||||
|
|
||||||
`Clay_ElementId CLAY_IDI_LOCAL(char *label, int index)`
|
|
||||||
|
|
||||||
An offset version of [CLAY_ID_LOCAL](#clay_local_id). Generates a [Clay_ElementId](#clay_elementid) string id from the provided `char *label`, combined with the `int index`. Used for generating ids for sequential elements (such as in a `for` loop) without having to construct dynamic strings at runtime.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CLAY_LAYOUT
|
### CLAY_LAYOUT
|
||||||
|
|
||||||
**Usage**
|
**Usage**
|
||||||
|
@ -87,8 +87,10 @@ Ray GetScreenToWorldPointWithZDistance(Vector2 position, Camera camera, int scre
|
|||||||
return ray;
|
return ray;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
uint32_t measureCalls = 0;
|
||||||
|
|
||||||
static inline Clay_Dimensions Raylib_MeasureText(Clay_StringSlice text, Clay_TextElementConfig *config, uintptr_t userData) {
|
static inline Clay_Dimensions Raylib_MeasureText(Clay_StringSlice text, Clay_TextElementConfig *config, uintptr_t userData) {
|
||||||
|
measureCalls++;
|
||||||
// Measure string size for Font
|
// Measure string size for Font
|
||||||
Clay_Dimensions textSize = { 0 };
|
Clay_Dimensions textSize = { 0 };
|
||||||
|
|
||||||
@ -97,9 +99,6 @@ static inline Clay_Dimensions Raylib_MeasureText(Clay_StringSlice text, Clay_Tex
|
|||||||
|
|
||||||
float textHeight = config->fontSize;
|
float textHeight = config->fontSize;
|
||||||
Font fontToUse = Raylib_fonts[config->fontId].font;
|
Font fontToUse = Raylib_fonts[config->fontId].font;
|
||||||
// Font failed to load, likely the fonts are in the wrong place relative to the execution dir
|
|
||||||
if (!fontToUse.glyphs) return textSize;
|
|
||||||
|
|
||||||
float scaleFactor = config->fontSize/(float)fontToUse.baseSize;
|
float scaleFactor = config->fontSize/(float)fontToUse.baseSize;
|
||||||
|
|
||||||
for (int i = 0; i < text.length; ++i)
|
for (int i = 0; i < text.length; ++i)
|
||||||
@ -130,6 +129,7 @@ void Clay_Raylib_Initialize(int width, int height, const char *title, unsigned i
|
|||||||
|
|
||||||
void Clay_Raylib_Render(Clay_RenderCommandArray renderCommands)
|
void Clay_Raylib_Render(Clay_RenderCommandArray renderCommands)
|
||||||
{
|
{
|
||||||
|
measureCalls = 0;
|
||||||
for (int j = 0; j < renderCommands.length; j++)
|
for (int j = 0; j < renderCommands.length; j++)
|
||||||
{
|
{
|
||||||
Clay_RenderCommand *renderCommand = Clay_RenderCommandArray_Get(&renderCommands, j);
|
Clay_RenderCommand *renderCommand = Clay_RenderCommandArray_Get(&renderCommands, j);
|
||||||
|
Loading…
Reference in New Issue
Block a user