| /* |
| * Copyright 2010 Google Inc. |
| * |
| * Use of this source code is governed by a BSD-style license that can be |
| * found in the LICENSE file. |
| */ |
| |
| #ifndef GrContext_DEFINED |
| #define GrContext_DEFINED |
| |
| #include "GrClip.h" |
| #include "GrColor.h" |
| #include "GrPaint.h" |
| #include "GrPathRendererChain.h" |
| #include "GrRenderTarget.h" |
| #include "GrTextureProvider.h" |
| #include "SkMatrix.h" |
| #include "SkPathEffect.h" |
| #include "SkTypes.h" |
| |
| class GrAARectRenderer; |
| class GrBatchFontCache; |
| class GrDrawTarget; |
| class GrFragmentProcessor; |
| class GrGpu; |
| class GrGpuTraceMarker; |
| class GrIndexBuffer; |
| class GrLayerCache; |
| class GrOvalRenderer; |
| class GrPath; |
| class GrPathRenderer; |
| class GrPipelineBuilder; |
| class GrResourceEntry; |
| class GrResourceCache; |
| class GrResourceProvider; |
| class GrTestTarget; |
| class GrTextBlobCache; |
| class GrTextContext; |
| class GrTextureParams; |
| class GrVertexBuffer; |
| class GrStrokeInfo; |
| class GrSoftwarePathRenderer; |
| class SkGpuDevice; |
| |
| class SK_API GrContext : public SkRefCnt { |
| public: |
| SK_DECLARE_INST_COUNT(GrContext) |
| |
| struct Options { |
| Options() : fDrawPathToCompressedTexture(false), fSuppressPrints(false) { } |
| |
| // EXPERIMENTAL |
| // May be removed in the future, or may become standard depending |
| // on the outcomes of a variety of internal tests. |
| bool fDrawPathToCompressedTexture; |
| bool fSuppressPrints; |
| }; |
| |
| /** |
| * Creates a GrContext for a backend context. |
| */ |
| static GrContext* Create(GrBackend, GrBackendContext, const Options* opts = NULL); |
| |
| /** |
| * Only defined in test apps. |
| */ |
| static GrContext* CreateMockContext(); |
| |
| virtual ~GrContext(); |
| |
| /** |
| * The GrContext normally assumes that no outsider is setting state |
| * within the underlying 3D API's context/device/whatever. This call informs |
| * the context that the state was modified and it should resend. Shouldn't |
| * be called frequently for good performance. |
| * The flag bits, state, is dpendent on which backend is used by the |
| * context, either GL or D3D (possible in future). |
| */ |
| void resetContext(uint32_t state = kAll_GrBackendState); |
| |
| /** |
| * Callback function to allow classes to cleanup on GrContext destruction. |
| * The 'info' field is filled in with the 'info' passed to addCleanUp. |
| */ |
| typedef void (*PFCleanUpFunc)(const GrContext* context, void* info); |
| |
| /** |
| * Add a function to be called from within GrContext's destructor. |
| * This gives classes a chance to free resources held on a per context basis. |
| * The 'info' parameter will be stored and passed to the callback function. |
| */ |
| void addCleanUp(PFCleanUpFunc cleanUp, void* info) { |
| CleanUpData* entry = fCleanUpData.push(); |
| |
| entry->fFunc = cleanUp; |
| entry->fInfo = info; |
| } |
| |
| /** |
| * Abandons all GPU resources and assumes the underlying backend 3D API |
| * context is not longer usable. Call this if you have lost the associated |
| * GPU context, and thus internal texture, buffer, etc. references/IDs are |
| * now invalid. Should be called even when GrContext is no longer going to |
| * be used for two reasons: |
| * 1) ~GrContext will not try to free the objects in the 3D API. |
| * 2) Any GrGpuResources created by this GrContext that outlive |
| * will be marked as invalid (GrGpuResource::wasDestroyed()) and |
| * when they're destroyed no 3D API calls will be made. |
| * Content drawn since the last GrContext::flush() may be lost. After this |
| * function is called the only valid action on the GrContext or |
| * GrGpuResources it created is to destroy them. |
| */ |
| void abandonContext(); |
| |
| /////////////////////////////////////////////////////////////////////////// |
| // Resource Cache |
| |
| /** |
| * Return the current GPU resource cache limits. |
| * |
| * @param maxResources If non-null, returns maximum number of resources that |
| * can be held in the cache. |
| * @param maxResourceBytes If non-null, returns maximum number of bytes of |
| * video memory that can be held in the cache. |
| */ |
| void getResourceCacheLimits(int* maxResources, size_t* maxResourceBytes) const; |
| |
| /** |
| * Gets the current GPU resource cache usage. |
| * |
| * @param resourceCount If non-null, returns the number of resources that are held in the |
| * cache. |
| * @param maxResourceBytes If non-null, returns the total number of bytes of video memory held |
| * in the cache. |
| */ |
| void getResourceCacheUsage(int* resourceCount, size_t* resourceBytes) const; |
| |
| /** |
| * Specify the GPU resource cache limits. If the current cache exceeds either |
| * of these, it will be purged (LRU) to keep the cache within these limits. |
| * |
| * @param maxResources The maximum number of resources that can be held in |
| * the cache. |
| * @param maxResourceBytes The maximum number of bytes of video memory |
| * that can be held in the cache. |
| */ |
| void setResourceCacheLimits(int maxResources, size_t maxResourceBytes); |
| |
| GrTextureProvider* textureProvider() { return fTextureProvider; } |
| const GrTextureProvider* textureProvider() const { return fTextureProvider; } |
| |
| /** |
| * Frees GPU created by the context. Can be called to reduce GPU memory |
| * pressure. |
| */ |
| void freeGpuResources(); |
| |
| /** |
| * Purge all the unlocked resources from the cache. |
| * This entry point is mainly meant for timing texture uploads |
| * and is not defined in normal builds of Skia. |
| */ |
| void purgeAllUnlockedResources(); |
| |
| ////////////////////////////////////////////////////////////////////////// |
| /// Texture and Render Target Queries |
| |
| /** |
| * Can the provided configuration act as a texture? |
| */ |
| bool isConfigTexturable(GrPixelConfig) const; |
| |
| /** |
| * Can non-power-of-two textures be used with tile modes other than clamp? |
| */ |
| bool npotTextureTileSupport() const; |
| |
| /** |
| * Return the max width or height of a texture supported by the current GPU. |
| */ |
| int getMaxTextureSize() const; |
| |
| /** |
| * Temporarily override the true max texture size. Note: an override |
| * larger then the true max texture size will have no effect. |
| * This entry point is mainly meant for testing texture size dependent |
| * features and is only available if defined outside of Skia (see |
| * bleed GM. |
| */ |
| void setMaxTextureSizeOverride(int maxTextureSizeOverride); |
| |
| /** |
| * Can the provided configuration act as a color render target? |
| */ |
| bool isConfigRenderable(GrPixelConfig config, bool withMSAA) const; |
| |
| /** |
| * Return the max width or height of a render target supported by the |
| * current GPU. |
| */ |
| int getMaxRenderTargetSize() const; |
| |
| /** |
| * Returns the max sample count for a render target. It will be 0 if MSAA |
| * is not supported. |
| */ |
| int getMaxSampleCount() const; |
| |
| /** |
| * Returns the recommended sample count for a render target when using this |
| * context. |
| * |
| * @param config the configuration of the render target. |
| * @param dpi the display density in dots per inch. |
| * |
| * @return sample count that should be perform well and have good enough |
| * rendering quality for the display. Alternatively returns 0 if |
| * MSAA is not supported or recommended to be used by default. |
| */ |
| int getRecommendedSampleCount(GrPixelConfig config, SkScalar dpi) const; |
| |
| /////////////////////////////////////////////////////////////////////////// |
| // Draws |
| |
| /** |
| * Clear the entire or rect of the render target, ignoring any clips. |
| * @param rect the rect to clear or the whole thing if rect is NULL. |
| * @param color the color to clear to. |
| * @param canIgnoreRect allows partial clears to be converted to whole |
| * clears on platforms for which that is cheap |
| * @param target The render target to clear. |
| */ |
| void clear(const SkIRect* rect, GrColor color, bool canIgnoreRect, GrRenderTarget* target); |
| |
| /** |
| * Draw everywhere (respecting the clip) with the paint. |
| */ |
| void drawPaint(GrRenderTarget*, const GrClip&, const GrPaint&, const SkMatrix& viewMatrix); |
| |
| /** |
| * Draw the rect using a paint. |
| * @param paint describes how to color pixels. |
| * @param viewMatrix transformation matrix |
| * @param strokeInfo the stroke information (width, join, cap), and. |
| * the dash information (intervals, count, phase). |
| * If strokeInfo == NULL, then the rect is filled. |
| * Otherwise, if stroke width == 0, then the stroke |
| * is always a single pixel thick, else the rect is |
| * mitered/beveled stroked based on stroke width. |
| * The rects coords are used to access the paint (through texture matrix) |
| */ |
| void drawRect(GrRenderTarget*, |
| const GrClip&, |
| const GrPaint& paint, |
| const SkMatrix& viewMatrix, |
| const SkRect&, |
| const GrStrokeInfo* strokeInfo = NULL); |
| |
| /** |
| * Maps a rectangle of shader coordinates to a rectangle and draws that rectangle |
| * |
| * @param paint describes how to color pixels. |
| * @param viewMatrix transformation matrix which applies to rectToDraw |
| * @param rectToDraw the rectangle to draw |
| * @param localRect the rectangle of shader coordinates applied to rectToDraw |
| * @param localMatrix an optional matrix to transform the shader coordinates before applying |
| * to rectToDraw |
| */ |
| void drawNonAARectToRect(GrRenderTarget*, |
| const GrClip&, |
| const GrPaint& paint, |
| const SkMatrix& viewMatrix, |
| const SkRect& rectToDraw, |
| const SkRect& localRect, |
| const SkMatrix* localMatrix = NULL); |
| |
| /** |
| * Draws a non-AA rect with paint and a localMatrix |
| */ |
| void drawNonAARectWithLocalMatrix(GrRenderTarget* rt, |
| const GrClip& clip, |
| const GrPaint& paint, |
| const SkMatrix& viewMatrix, |
| const SkRect& rect, |
| const SkMatrix& localMatrix) { |
| this->drawNonAARectToRect(rt, clip, paint, viewMatrix, rect, rect, &localMatrix); |
| } |
| |
| /** |
| * Draw a roundrect using a paint. |
| * |
| * @param paint describes how to color pixels. |
| * @param viewMatrix transformation matrix |
| * @param rrect the roundrect to draw |
| * @param strokeInfo the stroke information (width, join, cap) and |
| * the dash information (intervals, count, phase). |
| */ |
| void drawRRect(GrRenderTarget*, |
| const GrClip&, |
| const GrPaint&, |
| const SkMatrix& viewMatrix, |
| const SkRRect& rrect, |
| const GrStrokeInfo&); |
| |
| /** |
| * Shortcut for drawing an SkPath consisting of nested rrects using a paint. |
| * Does not support stroking. The result is undefined if outer does not contain |
| * inner. |
| * |
| * @param paint describes how to color pixels. |
| * @param viewMatrix transformation matrix |
| * @param outer the outer roundrect |
| * @param inner the inner roundrect |
| */ |
| void drawDRRect(GrRenderTarget*, |
| const GrClip&, |
| const GrPaint&, |
| const SkMatrix& viewMatrix, |
| const SkRRect& outer, |
| const SkRRect& inner); |
| |
| |
| /** |
| * Draws a path. |
| * |
| * @param paint describes how to color pixels. |
| * @param viewMatrix transformation matrix |
| * @param path the path to draw |
| * @param strokeInfo the stroke information (width, join, cap) and |
| * the dash information (intervals, count, phase). |
| */ |
| void drawPath(GrRenderTarget*, |
| const GrClip&, |
| const GrPaint&, |
| const SkMatrix& viewMatrix, |
| const SkPath&, |
| const GrStrokeInfo&); |
| |
| /** |
| * Draws vertices with a paint. |
| * |
| * @param paint describes how to color pixels. |
| * @param viewMatrix transformation matrix |
| * @param primitiveType primitives type to draw. |
| * @param vertexCount number of vertices. |
| * @param positions array of vertex positions, required. |
| * @param texCoords optional array of texture coordinates used |
| * to access the paint. |
| * @param colors optional array of per-vertex colors, supercedes |
| * the paint's color field. |
| * @param indices optional array of indices. If NULL vertices |
| * are drawn non-indexed. |
| * @param indexCount if indices is non-null then this is the |
| * number of indices. |
| */ |
| void drawVertices(GrRenderTarget*, |
| const GrClip&, |
| const GrPaint& paint, |
| const SkMatrix& viewMatrix, |
| GrPrimitiveType primitiveType, |
| int vertexCount, |
| const SkPoint positions[], |
| const SkPoint texs[], |
| const GrColor colors[], |
| const uint16_t indices[], |
| int indexCount); |
| |
| /** |
| * Draws an oval. |
| * |
| * @param paint describes how to color pixels. |
| * @param viewMatrix transformation matrix |
| * @param oval the bounding rect of the oval. |
| * @param strokeInfo the stroke information (width, join, cap) and |
| * the dash information (intervals, count, phase). |
| */ |
| void drawOval(GrRenderTarget*, |
| const GrClip&, |
| const GrPaint& paint, |
| const SkMatrix& viewMatrix, |
| const SkRect& oval, |
| const GrStrokeInfo& strokeInfo); |
| |
| /////////////////////////////////////////////////////////////////////////// |
| // Misc. |
| |
| /** |
| * Flags that affect flush() behavior. |
| */ |
| enum FlushBits { |
| /** |
| * A client may reach a point where it has partially rendered a frame |
| * through a GrContext that it knows the user will never see. This flag |
| * causes the flush to skip submission of deferred content to the 3D API |
| * during the flush. |
| */ |
| kDiscard_FlushBit = 0x2, |
| }; |
| |
| /** |
| * Call to ensure all drawing to the context has been issued to the |
| * underlying 3D API. |
| * @param flagsBitfield flags that control the flushing behavior. See |
| * FlushBits. |
| */ |
| void flush(int flagsBitfield = 0); |
| |
| /** |
| * These flags can be used with the read/write pixels functions below. |
| */ |
| enum PixelOpsFlags { |
| /** The GrContext will not be flushed before the surface read or write. This means that |
| the read or write may occur before previous draws have executed. */ |
| kDontFlush_PixelOpsFlag = 0x1, |
| /** Any surface writes should be flushed to the backend 3D API after the surface operation |
| is complete */ |
| kFlushWrites_PixelOp = 0x2, |
| /** The src for write or dst read is unpremultiplied. This is only respected if both the |
| config src and dst configs are an RGBA/BGRA 8888 format. */ |
| kUnpremul_PixelOpsFlag = 0x4, |
| }; |
| |
| /** |
| * Reads a rectangle of pixels from a render target. |
| * @param target the render target to read from. |
| * @param left left edge of the rectangle to read (inclusive) |
| * @param top top edge of the rectangle to read (inclusive) |
| * @param width width of rectangle to read in pixels. |
| * @param height height of rectangle to read in pixels. |
| * @param config the pixel config of the destination buffer |
| * @param buffer memory to read the rectangle into. |
| * @param rowBytes number of bytes bewtween consecutive rows. Zero means rows are tightly |
| * packed. |
| * @param pixelOpsFlags see PixelOpsFlags enum above. |
| * |
| * @return true if the read succeeded, false if not. The read can fail because of an unsupported |
| * pixel config or because no render target is currently set and NULL was passed for |
| * target. |
| */ |
| bool readRenderTargetPixels(GrRenderTarget* target, |
| int left, int top, int width, int height, |
| GrPixelConfig config, void* buffer, |
| size_t rowBytes = 0, |
| uint32_t pixelOpsFlags = 0); |
| |
| /** |
| * Writes a rectangle of pixels to a surface. |
| * @param surface the surface to write to. |
| * @param left left edge of the rectangle to write (inclusive) |
| * @param top top edge of the rectangle to write (inclusive) |
| * @param width width of rectangle to write in pixels. |
| * @param height height of rectangle to write in pixels. |
| * @param config the pixel config of the source buffer |
| * @param buffer memory to read pixels from |
| * @param rowBytes number of bytes between consecutive rows. Zero |
| * means rows are tightly packed. |
| * @param pixelOpsFlags see PixelOpsFlags enum above. |
| * @return true if the write succeeded, false if not. The write can fail because of an |
| * unsupported combination of surface and src configs. |
| */ |
| bool writeSurfacePixels(GrSurface* surface, |
| int left, int top, int width, int height, |
| GrPixelConfig config, const void* buffer, |
| size_t rowBytes, |
| uint32_t pixelOpsFlags = 0); |
| |
| /** |
| * Copies a rectangle of texels from src to dst. |
| * bounds. |
| * @param dst the surface to copy to. |
| * @param src the surface to copy from. |
| * @param srcRect the rectangle of the src that should be copied. |
| * @param dstPoint the translation applied when writing the srcRect's pixels to the dst. |
| * @param pixelOpsFlags see PixelOpsFlags enum above. (kUnpremul_PixelOpsFlag is not allowed). |
| */ |
| void copySurface(GrSurface* dst, |
| GrSurface* src, |
| const SkIRect& srcRect, |
| const SkIPoint& dstPoint, |
| uint32_t pixelOpsFlags = 0); |
| |
| /** Helper that copies the whole surface but fails when the two surfaces are not identically |
| sized. */ |
| bool copySurface(GrSurface* dst, GrSurface* src) { |
| if (NULL == dst || NULL == src || dst->width() != src->width() || |
| dst->height() != src->height()) { |
| return false; |
| } |
| this->copySurface(dst, src, SkIRect::MakeWH(dst->width(), dst->height()), |
| SkIPoint::Make(0,0)); |
| return true; |
| } |
| |
| /** |
| * After this returns any pending writes to the surface will have been issued to the backend 3D API. |
| */ |
| void flushSurfaceWrites(GrSurface* surface); |
| |
| /** |
| * Equivalent to flushSurfaceWrites but also performs MSAA resolve if necessary. This call is |
| * used to make the surface contents available to be read in the backend 3D API, usually for a |
| * compositing step external to Skia. |
| * |
| * It is not necessary to call this before reading the render target via Skia/GrContext. |
| * GrContext will detect when it must perform a resolve before reading pixels back from the |
| * surface or using it as a texture. |
| */ |
| void prepareSurfaceForExternalRead(GrSurface*); |
| |
| /** |
| * Provides a perfomance hint that the render target's contents are allowed |
| * to become undefined. |
| */ |
| void discardRenderTarget(GrRenderTarget*); |
| |
| /** |
| * An ID associated with this context, guaranteed to be unique. |
| */ |
| uint32_t uniqueID() { return fUniqueID; } |
| |
| /////////////////////////////////////////////////////////////////////////// |
| // Functions intended for internal use only. |
| GrGpu* getGpu() { return fGpu; } |
| const GrGpu* getGpu() const { return fGpu; } |
| GrBatchFontCache* getBatchFontCache() { return fBatchFontCache; } |
| GrLayerCache* getLayerCache() { return fLayerCache.get(); } |
| GrTextBlobCache* getTextBlobCache() { return fTextBlobCache; } |
| GrDrawTarget* getTextTarget(); |
| GrAARectRenderer* getAARectRenderer() { return fAARectRenderer; } |
| GrResourceProvider* resourceProvider() { return fResourceProvider; } |
| const GrResourceProvider* resourceProvider() const { return fResourceProvider; } |
| GrResourceCache* getResourceCache() { return fResourceCache; } |
| bool suppressPrints() const { return fOptions.fSuppressPrints; } |
| |
| // Called by tests that draw directly to the context via GrDrawTarget |
| void getTestTarget(GrTestTarget*); |
| |
| void addGpuTraceMarker(const GrGpuTraceMarker* marker); |
| void removeGpuTraceMarker(const GrGpuTraceMarker* marker); |
| |
| GrPathRenderer* getPathRenderer( |
| const GrDrawTarget* target, |
| const GrPipelineBuilder*, |
| const SkMatrix& viewMatrix, |
| const SkPath& path, |
| const GrStrokeInfo& stroke, |
| bool allowSW, |
| GrPathRendererChain::DrawType drawType = GrPathRendererChain::kColor_DrawType, |
| GrPathRendererChain::StencilSupport* stencilSupport = NULL); |
| |
| /** |
| * This returns a copy of the the GrContext::Options that was passed to the |
| * constructor of this class. |
| */ |
| const Options& getOptions() const { return fOptions; } |
| |
| /** Prints cache stats to the string if GR_CACHE_STATS == 1. */ |
| void dumpCacheStats(SkString*) const; |
| void printCacheStats() const; |
| |
| /** Prints GPU stats to the string if GR_GPU_STATS == 1. */ |
| void dumpGpuStats(SkString*) const; |
| void printGpuStats() const; |
| |
| private: |
| GrGpu* fGpu; |
| GrResourceCache* fResourceCache; |
| // this union exists because the inheritance of GrTextureProvider->GrResourceProvider |
| // is in a private header. |
| union { |
| GrResourceProvider* fResourceProvider; |
| GrTextureProvider* fTextureProvider; |
| }; |
| |
| GrBatchFontCache* fBatchFontCache; |
| SkAutoTDelete<GrLayerCache> fLayerCache; |
| SkAutoTDelete<GrTextBlobCache> fTextBlobCache; |
| |
| GrPathRendererChain* fPathRendererChain; |
| GrSoftwarePathRenderer* fSoftwarePathRenderer; |
| |
| GrDrawTarget* fDrawBuffer; |
| |
| // Set by OverbudgetCB() to request that GrContext flush before exiting a draw. |
| bool fFlushToReduceCacheSize; |
| GrAARectRenderer* fAARectRenderer; |
| GrOvalRenderer* fOvalRenderer; |
| |
| bool fDidTestPMConversions; |
| int fPMToUPMConversion; |
| int fUPMToPMConversion; |
| |
| struct CleanUpData { |
| PFCleanUpFunc fFunc; |
| void* fInfo; |
| }; |
| |
| SkTDArray<CleanUpData> fCleanUpData; |
| |
| int fMaxTextureSizeOverride; |
| |
| const Options fOptions; |
| const uint32_t fUniqueID; |
| |
| GrContext(const Options&); // init must be called after the constructor. |
| bool init(GrBackend, GrBackendContext); |
| void initMockContext(); |
| void initCommon(); |
| |
| class AutoCheckFlush; |
| // Sets the paint and returns the target to draw into. |
| GrDrawTarget* prepareToDraw(GrPipelineBuilder*, |
| GrRenderTarget* rt, |
| const GrClip&, |
| const GrPaint* paint, |
| const AutoCheckFlush*); |
| |
| // A simpler version of the above which just returns the draw target. Clip is *NOT* set |
| GrDrawTarget* prepareToDraw(); |
| |
| void internalDrawPath(GrDrawTarget*, |
| GrPipelineBuilder*, |
| const SkMatrix& viewMatrix, |
| GrColor, |
| bool useAA, |
| const SkPath&, |
| const GrStrokeInfo&); |
| |
| /** |
| * Creates a new text rendering context that is optimal for the |
| * render target and the context. Caller assumes the ownership |
| * of the returned object. The returned object must be deleted |
| * before the context is destroyed. |
| * TODO we can possibly bury this behind context, but we need to be able to use the |
| * drawText_asPaths logic on SkGpuDevice |
| */ |
| GrTextContext* createTextContext(GrRenderTarget*, |
| SkGpuDevice*, |
| const SkDeviceProperties&, |
| bool enableDistanceFieldFonts); |
| |
| |
| /** |
| * These functions create premul <-> unpremul effects if it is possible to generate a pair |
| * of effects that make a readToUPM->writeToPM->readToUPM cycle invariant. Otherwise, they |
| * return NULL. |
| */ |
| const GrFragmentProcessor* createPMToUPMEffect(GrTexture*, bool swapRAndB, const SkMatrix&); |
| const GrFragmentProcessor* createUPMToPMEffect(GrTexture*, bool swapRAndB, const SkMatrix&); |
| |
| /** |
| * This callback allows the resource cache to callback into the GrContext |
| * when the cache is still over budget after a purge. |
| */ |
| static void OverBudgetCB(void* data); |
| |
| /** |
| * A callback similar to the above for use by the TextBlobCache |
| * TODO move textblob draw calls below context so we can use the call above. |
| */ |
| static void TextBlobCacheOverBudgetCB(void* data); |
| |
| // TODO see note on createTextContext |
| friend class SkGpuDevice; |
| |
| typedef SkRefCnt INHERITED; |
| }; |
| |
| #endif |
