class Image
{
public
:
friend class Internal;
/// <summary>
/// The empty or "NULL" constructor
for an <c>Atil
::Image</c>
.
/// </summary>
///
/// <remarks>
/// An instance of an image created through this constructor is intended only to facilitate
/// the later assignment of a valid image
. The instance created through this constructor has
/// no internal data that can be returned
. Attempting access any data from a "NULL" image will
/// result in an exception
.
/// </remarks>
Image ();
/// <summary>
/// The clone constructor of the Image class allows the construction of a new instance based
/// on an existing instance
.
/// </summary>
///
/// <param name= &#
39;image&#
39;>
/// A const reference to the image to be copied
.
/// </param>
///
/// <exception cref="ImageConstructionException">Thrown when the image can
///
not be cloned <see cref="ImageConstructionException"/>
.
/// </exception>
///
/// <remarks>
/// ATIL implements the Image class with a "letter - envelope" or "Bridge"
/// design pattern
. See "Design Patterns, ISBN 0-201-6
3361-2"
.
/// </remarks>
///
Image (const Image & image);
/// <summary>
/// The blank image constructor
for an <c>Image</c>
.
/// </summary>
///
/// <param name=&#
39;size&#
39;>The size of the image to be created
.</param>
///
/// <param name=&#
39;colorspace&#
39;>The DataModel of the image to be created
.</param>
///
/// <param name=&#
39;initialColor&#
39;>The clear color of the image data
.</param>
///
/// <param name=&#
39;sz&#
39;>The tile size to use
for the image
.
/// The default, <c>DataModel
::TileSize
::kUnspecified</c> is recommended
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will be thrown
/// if the image can
not be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
Image (const Size& size, const DataModel* colorspace, ImagePixel initialColor,
DataModel
::TileSize sz = DataModel
::kUnspecified);
/// <summary>
/// The user supplied
buffer constructor
for <c>Atil
::Image</c>
. This method of construction
/// will wrap a user supplied
buffer with the Image object allowing ATIL and the using
/// application mutual access to the image data
. Images created in this way are
not memory managed
.
/// </summary>
///
/// <param name=&#
39;pData&#
39;>A pointer to the
buffer that the image should use
for its image
/// data storage
.
/// </param>
///
/// <param name=&#
39;nBytesIn
Buffer&#
39;>An integer that describes the number of bytes
/// that have been allocated in the <c>pData</c> parameter
.
/// </param>
///
/// <param name=&#
39;nBytesPerRow&#
39;>An integer that describes the number of bytes in
/// one row of the data
. This sometimes referred to as the stride of the data
.
/// The number of bytes from the beginning of one row to the beginning of the next row
.
/// </param>
///
/// <param name=&#
39;size&#
39;>The horizontal and vertical dimensions of the image
.
/// The
buffer in pData must be
large enough to hold these dimensions
.
/// </param>
///
/// <param name=&#
39;pDm&#
39;>A constant pointer to a <c>DataModel</c> instance that
/// represents the data that will be contained in the image
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will be thrown
/// if the image can
not be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
Image (void* pData, int nBytesIn
Buffer, int nBytesPerRow, const Size& size, const DataModel* pDm);
/// <summary>
/// A <c>RowProviderInterface</c> based constructor
for Image
.
/// </summary>
///
/// <param name=&#
39;pPipe&#
39;>A source of image data
.
/// </param>
///
/// <param name=&#
39;sz&#
39;>The tile size to be used
for the image
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will be thrown
/// if the image can
not be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
/// <remarks>
/// This method will "consume" the <c>RowProviderInterface</c> and free the resources
/// that it holds
. The <c>RowProviderInterface</c> is no longer valid after using
/// it in this method
.
/// </remarks>
///
Image (RowProviderInterface* pPipe,
DataModel
::TileSize sz = DataModel
::kUnspecified);
/// <summary>
/// A <c>RowProviderInterface</c> based constructor
for Image with the option
.
/// to reorient the input
.
/// </summary>
///
/// <param name=&#
39;pPipe&#
39;>A source of image data
.
/// </param>
///
/// <param name=&#
39;orient&#
39;>The orientation to apply to the image when storing
/// the data in the image
.
/// </param>
///
/// <param name=&#
39;sz&#
39;>The tile size to be used
for the image
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will be thrown
/// if the image can
not be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
Image (RowProviderInterface* pPipe, Atil
::Orientation orient,
DataModel
::TileSize sz = DataModel
::kUnspecified);
/// <summary>
/// The <c>FileReadDescriptor</c> based constructor
for Image
. This is the constructor
/// to use when you want to load an image from a file
.
/// </summary>
///
/// <param name=&#
39;readDesc&#
39;>The <c>FileReadDescriptor</c> source of image data
.
/// </param>
///
/// <param name=&#
39;sz&#
39;>The tile size to be used
for the image
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will be thrown
/// if the image can
not be constructed
. <see cref="ImageConstructionException"/>
.
/// </exception>
///
/// <remarks>
/// The image will be constructed from the current frame set in the FileReadDescriptor
.
/// </remarks>
///
Image (FileReadDescriptor& readDesc,
DataModel
::TileSize sz = DataModel
::kUnspecified);
/// <summary>
/// The destructor will release all image resources with the exception of
/// user allocated
buffers
.
/// </summary>
///
~Image ();
/// <summary>
/// The assignment operator will destroy the existing image data and make a reference
/// to the assigned image data
.
/// </summary>
///
/// <param name= &#
39;image&#
39;>
/// A const reference to the image to be assigned to <c>*this</c>
.
/// </param>
///
/// <returns>
/// This returns a reference to <c>*this</c>
.
/// </returns>
///
const Image& operator= (const Image& image);
/// <summary>
/// The assignment operator will destroy the existing image data and construct a new
/// image from the result of the <c>RowProviderInterface</c>
.
/// </summary>
///
/// <param name="pPipe">An instance of a <c>RowProviderInterface</c> that will supply
/// the pixel data to be drawn
. The <c>RowProviderInterface</c> is consumed and freed
.
/// </param>
///
/// <returns>
/// This returns a reference to <c>*this</c>
.
/// </returns>
///
/// <remarks>
/// This method will "consume" the <c>RowProviderInterface</c> and free the resources
/// that it holds
. The <c>RowProviderInterface</c> is no longer valid after using
/// it in this method
.
/// </remarks>
///
const Image& operator= (RowProviderInterface* pPipe);
/// <summary>
/// The equals operator
.
/// </summary>
///
/// <param name= &#
39;image&#
39;>
/// A const reference to the image to be compared
.
/// </param>
///
/// <returns>
/// This will return true of both objects refer to the same data
.
/// </returns>
///
/// <remarks>
/// While this method is provided it is
not considered a reliable method
for
/// testing equality
.
/// </remarks>
///
bool operator== (const Image& image) const;
/// <summary>
/// The
not equals operator
.
/// </summary>
///
/// <param name= &#
39;image&#
39;>
/// A const reference to the image to be compared
.
/// </param>
///
/// <returns>
/// This will return true of both objects do
not refer to the same data
.
/// </returns>
///
/// <remarks>
/// While this method is provided it is
not considered a reliable method
for
/// testing equality
.
/// </remarks>
///
bool operator!= (const Image& image) const;
/// <summary>
/// This returns the size of the image in
pixels.
/// </summary>
///
/// <returns>
/// This returns a const reference to a <c>Size</c> object
.
/// </returns>
///
const Size& size () const;
/// <summary>
/// This returns the size of a tile of the image in
pixels.
/// </summary>
///
/// <returns>
/// This returns a <c>Size</c> object
.
/// </returns>
///
Size tileSize () const;
/// <summary>
/// This method returns a const reference to the images dataModel
. It is useful
///
for testing the qualities of an image
. All images have a dataModel
.
/// </summary>
///
/// <returns>
/// This returns a const reference to the <c>DataModel</c>
for the image
.
/// </returns>
///
const DataModel& dataModel () const;
/// <summary>
/// This method will return the <c>FileReadDescriptor</c> used to create the image
/// if the image was created with a <c>FileReadDescriptor</c>
. The return will be
/// NULL otherwise
.
/// </summary>
///
/// <returns>
/// This returns a const pointer to the <c>FileReadDescriptor</c> if one was used
/// to construct the image and NULL if
not.
/// </returns>
///
const FileReadDescriptor* fileReadDescriptor () const;
/// <summary>
/// This method will return the number of tiles in the image
. There is always
/// at least one tile in a valid image
.
/// </summary>
///
/// <param name="nRows">A integer reference which will be set to the number of
/// tiles used to hold a row of the image
.
/// </param>
///
/// <param name="nColumns">A integer reference which will be set to the number of
/// tiles used to hold a column of the image
.
/// </param>
///
/// <returns>
/// This returns the number of tiles in the image
.
/// </returns>
///
int numTiles (int& nRows, int& nColumns) const;
/// <summary>
/// This method returns the clear color of the image
.
/// </summary>
///
/// <returns>
/// This returns a const reference to th <c>ImagePixel</c> that holds the clear color
.
/// </returns>
///
const ImagePixel& clearColor () const;
/// <summary>
/// A new data model may be set onto an image through this method
. The datamodel being
/// set must be compatible with the number of bands and band width of the image data
.
/// </summary>
///
/// <param name=&#
39;dataModel&#
39;>A constant reference to a <c>DataModel</c> instance that
/// will be used as the representation of the data
.
/// </param>
///
/// <exception cref="ImageConstructionException">An exception will be thrown
/// if the data type of the image is incompatible with the data model instance being set
/// <see cref="ImageConstructionException"/>
.
/// </exception>
///
void setDataModel ( const DataModel& dataModel );
/// <summary>
/// This method will set the Image&#
39;s clear color
.
/// </summary>
///
/// <param name="value">An <c>ImagePixel</c> that holds the color to be
/// used as the clear color
.
/// </param>
///
/// <exception cref="ImageException">An exception will be thrown if the pixel type of the
/// parameter is incompatible with the data model image <see cref="ImageException"/>
.
/// </exception>
///
/// <remarks>
/// The clear color is the color that will be return
for any pixel which is
not
/// set with a value by the constructed image
.
/// </remarks>
///
void setClearColor ( ImagePixel value );
/// <summary>
/// Use this method to draw
pixels from the <c>RowProviderInterface</c> into the image
/// at the specified location
.
/// </summary>
///
/// <param name="pPipe">An instance of a <c>RowProviderInterface</c> that will supply
/// the pixel data to be drawn
. The <c>RowProviderInterface</c> is consumed and freed
.
/// </param>
///
/// <param name="at">The offset, in
pixels, to the upper left corner at which the
/// first pixel of the first row from the <c>RowProviderInterface</c> will be drawn
.
/// </param>
///
/// <param name="bRespectTransparency">A defaulted(false) boolean that if true will
/// cause
pixels that have an alpha of 0
not to be drawn
.
/// </param>
///
/// <remarks>
/// This method will "consume" the <c>RowProviderInterface</c> and free the resources
/// that it holds
. The <c>RowProviderInterface</c> is no longer valid after using
/// it in this method
.
/// </remarks>
///
void paste (RowProviderInterface* pPipe, const Offset& at, bool bRespectTransparency = false);
/// <summary>
/// Use this method to draw
pixels into an image from the passed in <c>RowProviderInterface</c>
/// drawing the data with the specified alpha value
.
/// </summary>
///
/// <param name="pPipe">An instance of a <c>RowProviderInterface</c> that will supply
/// the pixel data to be drawn
. The <c>RowProviderInterface</c> is consumed and freed
.
/// </param>
///
/// <param name="at">The offset, in
pixels, to the upper left corner at which the
/// first pixel of the first row from the <c>RowProviderInterface</c> will be drawn
.
/// </param>
///
/// <param name="nAlphaValue">The input alpha range should vary between 1 and 25
4.
/// </param>
///
/// <param name="bRespectTransparency">A defaulted(false) boolean that if true will
/// cause
pixels that have an alpha of 0
not to be drawn
.
/// </param>
///
/// <exception cref="ImageException">An exception will be thrown if the image does
///
not have a RGB data model <see cref="ImageException"/>
.
/// </exception>
///
/// <remarks>
/// This works like the <c>paste()</c> method except that it alpha blends the
/// input rows into the image
.
/// Like <c>paste()</c> it will "consume" the <c>RowProviderInterface</c> and
/// free the resources that it holds
. The <c>RowProviderInterface</c> is no longer
/// valid after using it in this method
.
/// </remarks>
///
void blend (RowProviderInterface* pPipe, const Offset& at, int nAlphaValue
, bool bRespectTransparency = false);
/// <summary>
/// This will read a sub-rectangle of data from the image returning it in a
/// <c>RowProviderInterface</c> instance
.
/// </summary>
///
/// <param name="size">The size of the sub-region of the image to be read which may
/// be up to the full size of the image
.
/// </param>
///
/// <param name="offset">The pixel offset from the upper left corner of the image
/// to begin reading the requested <c>size</c> region
.
/// </param>
///
/// <returns>
/// An instance of a <c>RowProviderInterface</c> that will supply the data within
/// the requested region
.
/// </returns>
///
/// <remarks>
/// The requested sub-region must be within the bounds of the image
.
/// </remarks>
///
RowProviderInterface* read (const Size& size, const Offset& offset) const;
// Orientation is an enum containing the 8 different read orientations
.
/// <summary>
/// This will read a sub-rectangle of data from the image returning it in a
/// <c>RowProviderInterface</c> instance
. The data from the image will be
/// re-oriented from TopDownLeftRight (normal progression) to the orientation
/// passed in
.
/// </summary>
///
/// <param name="size">The size of the sub-region of the image to be read which may
/// be up to the full size of the image
.
/// </param>
///
/// <param name="offset">The pixel offset from the upper left corner of the image
/// to begin reading the requested <c>size</c> region
.
/// </param>
///
/// <param name="orient">The orientation to be applied to the data be
fore it is
/// returned
.
/// </param>
///
/// <returns>
/// An instance of a <c>RowProviderInterface</c> that will supply the data within
/// the requested region
.
/// </returns>
///
/// <remarks>
/// The requested sub-region must be within the bounds of the image
.
/// </remarks>
///
RowProviderInterface* read (const Size& size, const Offset& offset,
Atil
::Orientation orient) const;
/// <summary>
/// This method constructs an <c>ImageContext</c> <see cref="ImageContext"/> that
/// maybe used to access the
pixels of an image directly
.
/// </summary>
///
/// <param name="accessNeeded">An <c>ImageContext</c> can be opened
for either
/// kRead or kWrite access
. ImageContexts opened with kWrite do
not cache (internally)
/// as aggressively as those opened with kRead
.
/// </param>
///
/// <param name="numTilesToCache">The number of tiles to cache internal to the
/// <c>ImageContext</c>
. The default of
4 should be sufficient
for most usages
.
/// </param>
///
/// <returns>
/// This will return either a pointer to a valid <c>ImageContext</c><see cref="ImageContext"/>
/// or NULL if the method fails
. The returned object must be freed when the caller
/// is finished with it
.
/// </returns>
///
/// <remarks>
/// An <c>ImageContext</c> holds tiles while it exists
. They should be delete&#
39;d when
///
not in use to free the resources that it holds
.
/// </remarks>
///
ImageContext* createContext (ImageContext
::Access accessNeeded, int numTilesToCache =
4 );
/// <summary>
/// This method constructs an <c>ImageContext</c> <see cref="ImageContext"/> that
/// maybe used to access the
pixels of an image directly
.
/// </summary>
///
/// <param name="accessNeeded">An <c>ImageContext</c> can be opened
for either
/// kRead or kWrite access
. ImageContexts opened with kWrite do
not cache (internally)
/// as aggressively as those opened with kRead
.
/// </param>
///
/// <param name="size">The size of the sub-region of the image to be accessed by the
/// context
.
/// </param>
///
/// <param name="offset">The pixel offset from the upper left corner of the image
/// of the requested <c>size</c> region
.
/// </param>
///
/// <param name="numTilesToCache">The number of tiles to cache internal to the
/// <c>ImageContext</c>
. The default of
4 should be sufficient
for most usages
.
/// </param>
///
/// <returns>
/// This will return either a pointer to a valid <c>ImageContext</c><see cref="ImageContext"/>
/// or NULL if the method fails
. The returned object must be freed when the caller
/// is finished with it
.
/// </returns>
///
/// <remarks>
/// An <c>ImageContext</c> holds tiles while it exists
. They should be delete&#
39;d when
///
not in use to free the resources that it holds
.
/// </remarks>
///
ImageContext* createContext (ImageContext
::Access accessNeeded,
const Size& size, const Offset& offset, int numTilesToCache =
4 );
/// <summary>
/// Adds a reactor that will call the owner whenever a tile is saved
.
/// When a tile is saved, it is assumed to have been edited (written to)
.
/// </summary>
///
/// <param name="pReactor">An instance of a reactor to be added to the image
.
/// </param>
///
/// <remarks>
/// The <c>ImageReactorInterface</c><see cref="ImageReactorInterface"/>
/// can be derived from to track changes in the image
.
/// </remarks>
///
void addReactor ( ImageReactorInterface* pReactor );
/// <summary>
/// Removes the reactor that had previously been added to the image
.
/// </summary>
///
/// <param name="pReactor">The instance of a reactor to be removed from the image
.
/// </param>
///
void removeReactor ( ImageReactorInterface* pReactor );
/// <summary>
/// This method disables per tile locking
. ATIL implements per tile locking
for
/// read and write
. This option is provided as an optimization
for instances in
/// which a developer can guarantee single-threaded usage
. Use it carefully
.
/// </summary>
///
/// <param name= &#
39;bDisable&#
39;>
/// The boolean will disable per tile locking if set to true
.
/// </param>
///
/// <returns>
/// This will return true if per tile locking is disabled
.
/// </returns>
///
bool disablePerTileLocking ( bool bDisable );
/// <summary>
/// This method will cause all
pixels of the image to be set to the image&#
39;s
/// internal clear color
.
/// </summary>
///
void clear ();
/// <summary>
/// This method will return true if there is valid data within the image
.
/// </summary>
///
/// <returns>
/// This will return true if the image is valid
.
/// </returns>
///
bool isValid () const;
/// <summary>
/// This method will be set to true if data has been set into the image
/// after construction
. There is no way to reset it
.
/// </summary>
///
/// <returns>
/// This will return true if the image has been written to
.
/// </returns>
///
bool isModified () const;
/// <summary>
/// This method will return true if the "user
buffer" method of construction
/// was used to create the image
.
/// </summary>
///
/// <returns>
/// This will return true if a "user
buffer" was use to construct the image
.
/// </returns>
///
bool usesUser
Buffer () const;
/// <summary>
/// This method will return a pointer to the "user
buffer" used to construct
/// the image
.
/// </summary>
///
/// <returns>
/// This will return the "user
buffer" pointer used to construct the image
.
/// </returns>
void* getUser
Buffer ();
private
:
ImageRep* mImplementation;
};
Atil
::Image没有这个getPixel
函数啊，你看看Atil
::Image定义image->getPixel(x, y);应该怎么修改
在Android 4.3中，运行视频程序时遇到'Buffer not large enough for pixels'的致命错误。错误源于Bitmap.copyPixelsFromBuffer()方法。解决方案是在调用VideoView.onDraw()方法时，添加buffer.position(0)来重置缓冲区的位置，避免异常发生。
扫一扫
1012
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
