RSgImageCollection Class Reference
A handle to a reference-counted collection of images with the same attributes which is allocated in such a way that it can be used with the Graphics Composition Engine. Users can access each of the images in the collection individually through
RSgImage
handles. Interoperability with the Graphics Composition Engine is achieved by passing the surface identifier returned by
SurfaceId()
in calls to the Graphics Composition Engine API or the Surface Update API.
Since both images and image collections are reference-counted, and an image collection can only be destroyed as a whole, then an image collection is guaranteed to exist while there is an open
RSgImageCollection
handle referencing it or there are open
RSgImage
handles referencing any of the individual images in the collection.
A new
RSgImageCollection
handle does not refer to an image collection until a successful call to
Create()
. Before that point, the handle is said to be a null handle. Instances of
RSgImageCollection
can be shared among threads in the same process.
An
RSgImageCollection
handle is said to be invalid if it is not null but it does not reference an existing image collection. Copying an instance of
RSgImageCollection
must be done with extreme care, since it does not increment the reference count of the referenced image collection and may therefore allow some
RSgImageCollection
or
RSgImage
handle to become invalid when the image collection is destroyed.
RSgImage
Constructor & Destructor Documentation
RSgImageCollection()
IMPORT_C
|
RSgImageCollection
|
(
|
)
|
|
Member Functions Documentation
Count()
IMPORT_C
TInt
|
Count
|
(
|
)
|
const
|
Create(const TSgImageInfo &, TInt)
Create(const TSgImageInfo, TInt, RSgImageCollection, TInt)
IsNull()
IMPORT_C
TBool
|
IsNull
|
(
|
)
|
const
|
OpenImage(TInt, RSgImage &)
Member Data Documentation
MSgImageCollectionAdapter * iImpl
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.