Image Struct Reference

Image loading. More...

#include <Image.h>

Inheritance diagram for Image:

Public Member Functions
Class *	_Image (void)
	The Image archetype.
Image *	imageWithBytes (const uint8_t *bytes, size_t length)
	Instantiates an Image with the specified bytes.
Image *	imageWithData (const Data *data)
	Instantiates an Image with the specified Data.
Image *	imageWithResource (const Resource *resource)
	Instantiates an Image with the specified Resource.
Image *	imageWithResourceName (const char *name)
	Instantiates an Image with the specified Resource name.
Image *	imageWithSurface (SDL_Surface *surface)
	Instantiates an Image with the specified surface.
Image *	imageWithSVG (const uint8_t *bytes, size_t length, float scale)
	Instantiates an Image by rasterizing the specified SVG.
Image *	initWithBytes (Image *self, const uint8_t *bytes, size_t length)
	Initializes this Image with the specified bytes.
Image *	initWithData (Image *self, const Data *data)
	Initializes this Image with the specified Data.
Image *	initWithResource (Image *self, const Resource *resource)
	Initializes this Image with the specified Resource.
Image *	initWithResourceName (Image *self, const char *name)
	Initializes this Image, loading the Resource by the given name.
Image *	initWithSurface (Image *self, SDL_Surface *surface)
	Initializes this Image with the given surface.
Image *	initWithSVG (Image *self, const uint8_t *bytes, size_t length, float scale)
	Initializes this Image by rasterizing the specified SVG at its intrinsic size times scale.
Image *	initWithSVGSize (Image *self, const uint8_t *bytes, size_t length, SDL_Size points)
	Initializes this Image by rasterizing the specified SVG at points times the pixel density, so that Image::size reports points.
SDL_Size	size (const Image *self)

Data Fields
Object	object
	The superclass.
float	scale
	Pixels of surface per point: 1 for raster images, the requested scale for SVG.
SDL_Surface *	surface
	The backing surface.
const char *	type
	The image type, inferred if instantiated with a Resource.

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

Detailed Description

Image loading.

Raster formats load at their native size. SVG, recognized by type or by sniffing, rasterizes at its intrinsic size times a scale, so that a vector asset drawn into a frame of its intrinsic size stays sharp at any pixel density; Image::size reports points.

Definition at line 41 of file Image.h.

Member Function Documentation

_Image()

Class * _Image

(

void

)

The Image archetype.

Returns

The Image Class.

Definition at line 452 of file Image.c.

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

imageWithBytes()

Image * imageWithBytes	(	const uint8_t *	bytes,
		size_t	length
	)

Instantiates an Image with the specified bytes.

Parameters

bytes	The encoded image bytes.
length	The length of bytes.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The new Image, or NULL on error.

imageWithData()

Image * imageWithData

(

const Data *

data

)

Instantiates an Image with the specified Data.

Parameters

data	The encoded image Data.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The new Image, or NULL on error.

imageWithResource()

Image * imageWithResource

(

const Resource *

resource

)

Instantiates an Image with the specified Resource.

Parameters

resource	The Resource containing encoded image data.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The new Image, or NULL on error.

imageWithResourceName()

Image * imageWithResourceName

(

const char *

name

)

Instantiates an Image with the specified Resource name.

Parameters

name	The name of a Resource containing encoded image data.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The new Image, or NULL on error.

imageWithSurface()

Image * imageWithSurface

(

SDL_Surface *

surface

)

Instantiates an Image with the specified surface.

Parameters

surface

The surface.

Returns

The new Image, or NULL on error.

Definition at line 82 of file Image.c.

                                                     {
  return $(alloc(Image), initWithSurface, surface);
}

imageWithSVG()

Image * imageWithSVG	(	const uint8_t *	bytes,
		size_t	length,
		float	scale
	)

Instantiates an Image by rasterizing the specified SVG.

Parameters

bytes	The SVG document.
length	The length of bytes.
scale	Pixels per point, e.g. the window's pixel density.

Returns

The new Image, or NULL on error.

Definition at line 90 of file Image.c.

                                                                             {
  return $(alloc(Image), initWithSVG, bytes, length, scale);
}

initWithBytes()

Image * initWithBytes	(	Image *	self,
		const uint8_t *	bytes,
		size_t	length
	)

Initializes this Image with the specified bytes.

Parameters

self	The Image.
bytes	The encoded image bytes.
length	The length of bytes.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The initialized Image, or NULL on error.

initWithData()

Image * initWithData	(	Image *	self,
		const Data *	data
	)

Initializes this Image with the specified Data.

Parameters

self	The Image.
data	The encoded image Data.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The initialized Image, or NULL on error.

initWithResource()

Image * initWithResource	(	Image *	self,
		const Resource *	resource
	)

Initializes this Image with the specified Resource.

Parameters

self	The Image.
resource	The Resource containing encoded image data.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The initialized Image, or NULL on error.

initWithResourceName()

Image * initWithResourceName	(	Image *	self,
		const char *	name
	)

Initializes this Image, loading the Resource by the given name.

An @ decoration is interpreted, and where it sits says what it is. Trailing the whole name, heart.svg@24x24 rasterizes a vector at that size in points; it is a request rather than part of any file's name, so heart.svg is what loads. Inside the name, before the extension, heart@2x.png declares that a raster carries that many pixels per point, following Apple's convention, and names the file to load. An undecorated raster prefers the variant matching the pixel density where one exists, so heart.png loads heart@2x.png on a 2x display; an undecorated vector simply rasterizes at the pixel density.

Parameters

self	The Image.
name	The Resource name.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The initialized Image, or NULL on error.

initWithSurface()

Image * initWithSurface	(	Image *	self,
		SDL_Surface *	surface
	)

Initializes this Image with the given surface.

Parameters

self	The Image.
surface	The backing surface.

Returns

The initialized Image, or NULL on error.

Remarks

The surface's reference count is incremented, so that you can (and should) call SDL_DestroySurface when you no longer need it. The Image will also free the surface on dealloc.

Designated initializer.

Definition at line 391 of file Image.c.

                                                                 {
 
  self = (Image *) super(Object, self, init);
  if (self) {
    self->scale = 1.f;
 
    if (surface) {
      if (surface->format != SDL_PIXELFORMAT_RGBA32) {
        self->surface = SDL_ConvertSurface(surface, SDL_PIXELFORMAT_RGBA32);
      } else {
        self->surface = surface;
        self->surface->refcount++;
      }
 
      assert(self->surface);
    }
  }
 
  return self;
}

initWithSVG()

Image * initWithSVG	(	Image *	self,
		const uint8_t *	bytes,
		size_t	length,
		float	scale
	)

Initializes this Image by rasterizing the specified SVG at its intrinsic size times scale.

Parameters

self	The Image.
bytes	The SVG document.
length	The length of bytes.
scale	Pixels per point, e.g. the window's pixel density.

Returns

The initialized Image, or NULL on error.

Definition at line 327 of file Image.c.

                                                                                         {
 
  scale = scale > 0.f ? scale : 1.f;
 
  SDL_Surface *surface = rasterizeSVG(bytes, length, MakeSize(0, 0));
 
  if (surface && scale != 1.f) {
    const SDL_Size size = MakeSize(
      (int) SDL_roundf(surface->w * scale),
      (int) SDL_roundf(surface->h * scale)
    );
 
    SDL_DestroySurface(surface);
    surface = rasterizeSVG(bytes, length, size);
  }
 
  if (surface) {
    self = $(self, initWithSurface, surface);
    SDL_DestroySurface(surface);
 
    if (self) {
      self->type = "svg";
      self->scale = scale;
    }
  } else {
    MVC_LogWarn("%s\n", SDL_GetError());
    self = release(self);
  }
 
  return self;
}

initWithSVGSize()

Image * initWithSVGSize	(	Image *	self,
		const uint8_t *	bytes,
		size_t	length,
		SDL_Size	points
	)

Initializes this Image by rasterizing the specified SVG at points times the pixel density, so that Image::size reports points.

Parameters

self	The Image.
bytes	The SVG document.
length	The length of bytes.
points	The desired size, in points.
pixelDensity	Pixels per point, e.g. the window's pixel density.

Returns

The initialized Image, or NULL on error.

size()

SDL_Size size

(

const Image *

self

)

Parameters

self	The Image.

Returns

The Image size.

Definition at line 416 of file Image.c.

                                        {
  return MakeSize(
    (int) SDL_roundf(self->surface->w / self->scale),
    (int) SDL_roundf(self->surface->h / self->scale)
  );
}

Field Documentation

interface

ImageInterface* Image::interface[0]

protected

The interface type.

Definition at line 52 of file Image.h.

object

Object Image::object

The superclass.

Definition at line 46 of file Image.h.

scale

float Image::scale

Pixels of surface per point: 1 for raster images, the requested scale for SVG.

Definition at line 57 of file Image.h.

surface

SDL_Surface* Image::surface

The backing surface.

Definition at line 62 of file Image.h.

type

const char* Image::type

The image type, inferred if instantiated with a Resource.

Definition at line 67 of file Image.h.

---

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

• Sources/ObjectivelyMVC/Image.h
• Sources/ObjectivelyMVC/Image.c