Image Struct Reference

Image loading. More...

#include <Image.h>

Inheritance diagram for Image:

Public Member Functions
Class *	_Image (void)
	The Image archetype. More...
Image *	imageWithBytes (const uint8_t *bytes, size_t length)
	Instantiates an Image with the specified bytes. More...
Image *	imageWithData (const Data *data)
	Instantiates an Image with the specified Data. More...
Image *	imageWithResource (const Resource *resource)
	Instantiates an Image with the specified Resource. More...
Image *	imageWithResourceName (const char *name)
	Instantiates an Image with the specified Resource name. More...
Image *	imageWithSurface (SDL_Surface *surface)
	Instantiates an Image with the specified surface. More...
Image *	initWithBytes (Image *self, const uint8_t *bytes, size_t length)
	Initializes this Image with the specified bytes. More...
Image *	initWithData (Image *self, const Data *data)
	Initializes this Image with the specified Data. More...
Image *	initWithResource (Image *self, const Resource *resource)
	Initializes this Image with the specified Resource. More...
Image *	initWithResourceName (Image *self, const char *name)
	Initializes this Image, loading the Resource by the given name. More...
Image *	initWithSurface (Image *self, SDL_Surface *surface)
	Initializes this Image with the given surface. More...
SDL_Size	size (const Image *self)

Data Fields
Object	object
	The superclass. More...
SDL_Surface *	surface
	The backing surface. More...
const char *	type
	The image type, inferred if instantiated with a Resource. More...

Protected Attributes
ImageInterface *	interface
	The interface. More...

Detailed Description

Image loading.

Definition at line 38 of file Image.h.

Member Function Documentation

_Image()

Class * _Image

(

void

)

The Image archetype.

Returns

The Image Class.

Definition at line 211 of file Image.c.

                    {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "Image",
            .superclass = _Object(),
            .instanceSize = sizeof(Image),
            .interfaceOffset = offsetof(Image, interface),
            .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.

Returns

The new Image, or NULL on error.

Definition at line 48 of file Image.c.

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

imageWithData()

Image * imageWithData

(

const Data *

data

)

Instantiates an Image with the specified Data.

Parameters

data	The encoded image Data.

Returns

The new Image, or NULL on error.

Definition at line 56 of file Image.c.

                                              {
    return $(alloc(Image), initWithData, data);
}

imageWithResource()

Image * imageWithResource

(

const Resource *

resource

)

Instantiates an Image with the specified Resource.

Parameters

resource

The Resource containing encoded image data.

Returns

The new Image, or NULL on error.

Definition at line 64 of file Image.c.

                                                          {
    return $(alloc(Image), initWithResource, resource);
}

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.

Returns

The new Image, or NULL on error.

Definition at line 72 of file Image.c.

                                                      {
    return $(alloc(Image), initWithResourceName, name);
}

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 80 of file Image.c.

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

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.

Returns

The initialized Image, or NULL on error.

Definition at line 88 of file Image.c.

                                                                              {
 
    SDL_RWops *ops = SDL_RWFromConstMem(bytes, (int) length);
    if (ops) {
        SDL_Surface *surface = IMG_LoadTyped_RW(ops, 0, self->type);
        if (surface) {
            self = $(self, initWithSurface, surface);
            SDL_FreeSurface(surface);
        } else {
            self = release(self);
        }
    } else {
        self = release(self);
    }
 
    SDL_FreeRW(ops);
    return self;
}

initWithData()

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

Initializes this Image with the specified Data.

Parameters

self	The Image.
data	The encoded image Data.

Returns

The initialized Image, or NULL on error.

Definition at line 111 of file Image.c.

                                                          {
 
    if (data) {
        self = $(self, initWithBytes, data->bytes, data->length);
    } else {
        self = release(self);
    }
 
    return self;
}

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.

Returns

The initialized Image, or NULL on error.

Definition at line 126 of file Image.c.

                                                                      {
 
    if (resource) {
        self->type = strrchr(resource->name, '.') ? strrchr(resource->name, '.') + 1 : NULL;
        self = $(self, initWithData, resource->data);
    } else {
        self = release(self);
    }
 
    return self;
}

initWithResourceName()

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

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

Parameters

self	The Image.
name	The Resource name.

Returns

The initialized Image, or NULL on error.

Definition at line 142 of file Image.c.

                                                                  {
 
    Resource *resource = $$(Resource, resourceWithName, name);
 
    self = $(self, initWithResource, resource);
 
    release(resource);
 
    return self;
}

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_FreeSurface when you no longer need it. The Image will also free the surface on dealloc.

Designated initializer.

Definition at line 157 of file Image.c.

                                                                 {
 
    self = (Image *) super(Object, self, init);
    if (self) {
 
        if (surface) {
            if (surface->format->format != SDL_PIXELFORMAT_ABGR8888) {
                self->surface = SDL_ConvertSurfaceFormat(surface, SDL_PIXELFORMAT_ABGR8888, 0);
            } else {
                self->surface = surface;
                self->surface->refcount++;
            }
 
            assert(self->surface);
        }
    }
 
    return self;
}

size()

SDL_Size size

(

const Image *

self

)

Parameters

self	The Image.

Returns

The Image size.

Definition at line 181 of file Image.c.

                                        {
    return MakeSize(self->surface->w, self->surface->h);
}

Field Documentation

interface

ImageInterface* Image::interface

protected

The interface.

Definition at line 49 of file Image.h.

object

Object Image::object

The superclass.

Definition at line 43 of file Image.h.

surface

SDL_Surface* Image::surface

The backing surface.

Definition at line 54 of file Image.h.

type

const char* Image::type

The image type, inferred if instantiated with a Resource.

Definition at line 59 of file Image.h.

---

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

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