Theme Struct Reference

The Theme type. More...

#include <Theme.h>

Inheritance diagram for Theme:

Public Member Functions
Class *	_Theme (void)
	The Theme archetype.
AtlasImage *	addIcon (Theme *self, const char *name, Image *image)
	Registers image as the icon name, so that :name: in any Text drawn under this Theme renders it inline, and Theme::icon resolves it.
void	addStylesheet (Theme *self, Stylesheet *stylesheet)
	Adds the specified Stylesheet to this Theme.
void	apply (const Theme *self, const View *view)
	Applies this Theme to the given View.
Style *	computeStyle (const Theme *self, View *view)
Font *	font (Theme *self, const FontAttributes *attributes, float pixelDensity)
	Resolves the Font with the given attributes at the given pixel density.
AtlasImage *	icon (Theme *self, const char *name)
ImageAtlas *	icons (Theme *self)
	Returns the ImageAtlas holding this Theme's icons, and any other app art added to it, creating it on first access.
Image *	image (Theme *self, const char *name, float pixelDensity)
	Resolves the Image for the given Resource name at the given pixel density.
Theme *	init (Theme *self)
	Initializes this Theme.
void	removeStylesheet (Theme *self, Stylesheet *stylesheet)
	Removes the given Stylesheet from this Theme.
void	renderDeviceDidReset (Theme *self)
	Notifies this Theme that the render device has been reset.
void	renderDeviceWillReset (Theme *self)
	Releases the GPU resources of every cached Font's bitmap, and of Theme::icons if it has been created, ahead of a render device reset.
Theme *	theme (SDL_Window *window)

Data Fields
Object	object
	The superclass.
Array *	stylesheets
	The Stylesheets, in order of priority.

Protected Attributes
ThemeInterface *	interface [0]
	The interface type.

Detailed Description

The Theme type.

Definition at line 54 of file Theme.h.

Member Function Documentation

_Theme()

Class * _Theme

(

void

)

The Theme archetype.

Returns

The Theme Class.

Definition at line 334 of file Theme.c.

                    {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "Theme",
      .superclass = _Object(),
      .instanceSize = sizeof(Theme),
      .interfaceSize = sizeof(ThemeInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

addIcon()

AtlasImage * addIcon	(	Theme *	self,
		const char *	name,
		Image *	image
	)

Registers image as the icon name, so that :name: in any Text drawn under this Theme renders it inline, and Theme::icon resolves it.

The icon is added to Theme::icons and the atlas is compiled, which repacks it, so register icons at startup rather than while drawing. AtlasImages already handed out stay valid: compiling updates their rects in place. Icons SHOULD be square; Text draws them as a square of the line height.

Parameters

self	The Theme.
name	The name, of [A-Za-z0-9_-], under 64 bytes.
image	The Image.

Returns

The AtlasImage, owned by this Theme's icon atlas.

Definition at line 158 of file Theme.c.

                                                                        {
 
  ImageAtlas *atlas = $(self, icons);
 
  AtlasImage *icon = $(atlas, addImageWithName, name, image);
 
  if (!$(atlas, compile)) {
    MVC_LogError("Failed to compile icons after adding %s\n", name);
  }
 
  return icon;
}

addStylesheet()

void addStylesheet	(	Theme *	self,
		Stylesheet *	stylesheet
	)

Adds the specified Stylesheet to this Theme.

Parameters

self	The Theme.
stylesheet	The Stylesheet.

Definition at line 59 of file Theme.c.

                                                               {
  $((Array *) self->stylesheets, addObject, stylesheet);
}

apply()

void apply	(	const Theme *	self,
		const View *	view
	)

Applies this Theme to the given View.

Parameters

self	The Theme.
view	The View.

computeStyle()

Style * computeStyle	(	const Theme *	self,
		View *	view
	)

font()

Font * font	(	Theme *	self,
		const FontAttributes *	attributes,
		float	pixelDensity
	)

Resolves the Font with the given attributes at the given pixel density.

Instances are cached by this Theme, keyed by attributes and pixel density, so repeated requests – including from multiple windows sharing this Theme – return the same Font.

Parameters

self	The Theme.
attributes	The FontAttributes.
pixelDensity	The pixel density.

Returns

The Font, owned by this Theme. Callers retaining it beyond the current frame MUST re-resolve after a pixel density change.

Definition at line 108 of file Theme.c.

                                                                                     {
 
  String *key = cacheKey(attributes, pixelDensity);
 
  Font *font = $(self->fontCache, objectForKeyPath, key->chars);
  if (font == NULL) {
 
    Font *resolved = $$(Font, fontWithAttributes, attributes, pixelDensity);
    assert(resolved);
 
    // Keyed by the resolved Font's own name: when the requested family is not registered,
    // Font::fontWithAttributes falls back to the default Font, and caching that under the
    // requested key would pin the wrong Font to it permanently. This way the request
    // simply misses again, and heals once the family is registered via Font::cacheFont.
    const FontAttributes resolvedAttributes = { resolved->family, resolved->size, resolved->style };
    String *resolvedKey = cacheKey(&resolvedAttributes, pixelDensity);
 
    font = $(self->fontCache, objectForKeyPath, resolvedKey->chars);
    if (font == NULL) {
      $(self->fontCache, setObjectForKeyPath, resolved, resolvedKey->chars);
      font = resolved;
    }
 
    release(resolvedKey);
    release(resolved);
  }
 
  release(key);
 
  return font;
}

icon()

AtlasImage * icon	(	Theme *	self,
		const char *	name
	)

Parameters

self	The Theme.
name	The name.

Returns

The icon registered under name via Theme::addIcon, or NULL.

Definition at line 175 of file Theme.c.

                                                       {
  return $($(self, icons), imageWithName, name);
}

icons()

ImageAtlas * icons

(

Theme *

self

)

Returns the ImageAtlas holding this Theme's icons, and any other app art added to it, creating it on first access.

Theme::addIcon is the usual way in. Apps MAY also add unnamed art directly (ImageAtlas::addImage, then ImageAtlas::compile) exactly as with any other ImageAtlas; Theme owns the instance and forwards render device resets to it, so such art gets correct GPU resource lifecycle for free.

Parameters

self	The Theme.

Returns

This Theme's icon ImageAtlas, owned by this Theme.

Definition at line 144 of file Theme.c.

                                      {
 
  if (self->icons == NULL) {
    self->icons = $(alloc(ImageAtlas), init);
    assert(self->icons);
  }
 
  return self->icons;
}

image()

Image * image	(	Theme *	self,
		const char *	name,
		float	pixelDensity
	)

Resolves the Image for the given Resource name at the given pixel density.

Parameters

self	The Theme.
name	The Resource name, which may carry an @ decoration (see Image).
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The Image, retained by this Theme, or NULL if it could not be loaded.

Definition at line 82 of file Theme.c.

                                                                       {
 
  assert(name);
 
  String *key = str("%s@%g", name, pixelDensity);
  assert(key);
 
  Image *image = $(self->imageCache, objectForKeyPath, key->chars);
  if (image == NULL) {
 
    image = $$(Image, imageWithResourceName, name, pixelDensity);
    if (image) {
      $(self->imageCache, setObjectForKeyPath, image, key->chars);
      release(image);
    }
  }
 
  release(key);
 
  return image;
}

init()

Theme * init

(

Theme *

self

)

Initializes this Theme.

Parameters

self	The Theme.

Returns

The initialized Theme, or NULL on error.

Definition at line 237 of file Theme.c.

                                {
 
  self = (Theme *) super(Object, self, init);
  if (self) {
 
    self->fontCache = $$(Dictionary, dictionary);
    assert(self->fontCache);
 
    self->imageCache = $$(Dictionary, dictionary);
    assert(self->imageCache);
 
    self->stylesheets = $$(Array, arrayWithCapacity, 8);
    assert(self->stylesheets);
 
    $(self, addStylesheet, $$(Stylesheet, defaultStylesheet));
  }
 
  return self;
}

removeStylesheet()

void removeStylesheet	(	Theme *	self,
		Stylesheet *	stylesheet
	)

Removes the given Stylesheet from this Theme.

Parameters

self	The Theme.
stylesheet	The Stylesheet.

Definition at line 261 of file Theme.c.

                                                                  {
  $((Array *) self->stylesheets, removeObject, stylesheet);
}

renderDeviceDidReset()

void renderDeviceDidReset

(

Theme *

self

)

Notifies this Theme that the render device has been reset.

Parameters

self	The Theme.

Definition at line 287 of file Theme.c.

                                              {
  // Bitmap Textures are recreated lazily by ImageAtlas::texture on next use.
}

renderDeviceWillReset()

void renderDeviceWillReset

(

Theme *

self

)

Releases the GPU resources of every cached Font's bitmap, and of Theme::icons if it has been created, ahead of a render device reset.

Fonts are cached here, not owned by the Views drawing them, so this Theme is the one place that reliably reaches every bitmap Texture, including one no live View references.

Parameters

self	The Theme.

Definition at line 276 of file Theme.c.

                                               {
  $(self->fontCache, enumerateObjectsAndKeys, renderDeviceWillReset_enumerate, NULL);
  if (self->icons) {
    $(self->icons, renderDeviceWillReset);
  }
}

theme()

Theme * theme

(

SDL_Window *

window

)

Parameters

window

The window.

Returns

The Theme for the given window.

Definition at line 295 of file Theme.c.

                                        {
 
  assert(window);
 
  WindowController *windowController = $$(WindowController, windowController, window);
  if (windowController) {
    return windowController->theme;
  }
 
  return NULL;
}

Field Documentation

interface

ThemeInterface* Theme::interface[0]

protected

The interface type.

Definition at line 65 of file Theme.h.

object

Object Theme::object

The superclass.

Definition at line 59 of file Theme.h.

stylesheets

Array* Theme::stylesheets

The Stylesheets, in order of priority.

Definition at line 89 of file Theme.h.

---

The documentation for this struct was generated from the following files:

• Sources/ObjectivelyMVC/Theme.h
• Sources/ObjectivelyMVC/Theme.c