rsAllocation.h revision 96abf819e50b59ba8cf886c13f894633eb0a24ba 
1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_STRUCTURED_ALLOCATION_H
18#define ANDROID_STRUCTURED_ALLOCATION_H
19
20#include "rsType.h"
21
22// ---------------------------------------------------------------------------
23namespace android {
24namespace renderscript {
25
26class Program;
27
28class Allocation : public ObjectBase
29{
30    // The graphics equilivent of malloc.  The allocation contains a structure of elements.
31
32public:
33    // By policy this allocation will hold a pointer to the type
34    // but will not destroy it on destruction.
35    Allocation(Context *rsc, const Type *);
36    Allocation(Context *rsc, const Type *, void *bmp, void *callbackData, RsBitmapCallback_t callback);
37
38    virtual ~Allocation();
39
40    void setCpuWritable(bool);
41    void setGpuWritable(bool);
42    void setCpuReadable(bool);
43    void setGpuReadable(bool);
44
45    bool fixAllocation();
46
47    void * getPtr() const {return mPtr;}
48    const Type * getType() const {return mType.get();}
49
50    void deferedUploadToTexture(const Context *rsc, bool genMipmap, uint32_t lodOffset);
51    void uploadToTexture(const Context *rsc);
52    uint32_t getTextureID() const {return mTextureID;}
53
54    void deferedUploadToBufferObject(const Context *rsc);
55    void uploadToBufferObject(const Context *rsc);
56    uint32_t getBufferObjectID() const {return mBufferID;}
57
58    void copyRange1D(Context *rsc, const Allocation *src, int32_t srcOff, int32_t destOff, int32_t len);
59
60    void resize1D(Context *rsc, uint32_t dimX);
61    void resize2D(Context *rsc, uint32_t dimX, uint32_t dimY);
62
63    void data(Context *rsc, const void *data, uint32_t sizeBytes);
64    void subData(Context *rsc, uint32_t xoff, uint32_t count, const void *data, uint32_t sizeBytes);
65    void subData(Context *rsc, uint32_t xoff, uint32_t yoff,
66                 uint32_t w, uint32_t h, const void *data, uint32_t sizeBytes);
67    void subData(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff,
68                 uint32_t w, uint32_t h, uint32_t d, const void *data, uint32_t sizeBytes);
69
70    void subElementData(Context *rsc, uint32_t x,
71                        const void *data, uint32_t elementOff, uint32_t sizeBytes);
72    void subElementData(Context *rsc, uint32_t x, uint32_t y,
73                        const void *data, uint32_t elementOff, uint32_t sizeBytes);
74
75    void read(void *data);
76
77    void enableGLVertexBuffers() const;
78    void setupGLIndexBuffers() const;
79
80    void addProgramToDirty(const Program *);
81    void removeProgramToDirty(const Program *);
82
83    virtual void dumpLOGV(const char *prefix) const;
84    virtual void serialize(OStream *stream) const;
85    virtual RsA3DClassID getClassId() const { return RS_A3D_CLASS_ID_ALLOCATION; }
86    static Allocation *createFromStream(Context *rsc, IStream *stream);
87
88    virtual void uploadCheck(const Context *rsc);
89
90    bool getIsTexture() const {return mIsTexture;}
91    bool getIsBufferObject() const {return mIsVertexBuffer;}
92
93    void incRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
94    void decRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
95
96    void sendDirty() const;
97    bool getHasGraphicsMipmaps() const {return mTextureGenMipmap;}
98
99protected:
100    ObjectBaseRef<const Type> mType;
101    void * mPtr;
102
103    Vector<const Program *> mToDirtyList;
104
105    // Is we have a non-null user bitmap callback we do not own the bits and
106    // instead call this function to free the memort when its time.
107    RsBitmapCallback_t mUserBitmapCallback;
108    void *mUserBitmapCallbackData;
109
110    // Usage restrictions
111    bool mCpuWrite;
112    bool mCpuRead;
113    bool mGpuWrite;
114    bool mGpuRead;
115
116    // more usage hint data from the application
117    // which can be used by a driver to pick the best memory type.
118    // Likely ignored for now
119    float mReadWriteRatio;
120    float mUpdateSize;
121
122
123    // Is this a legal structure to be used as a texture source.
124    // Initially this will require 1D or 2D and color data
125    bool mIsTexture;
126    bool mTextureGenMipmap;
127    uint32_t mTextureLOD;
128    uint32_t mTextureID;
129
130    // Is this a legal structure to be used as a vertex source.
131    // Initially this will require 1D and x(yzw).  Additional per element data
132    // is allowed.
133    bool mIsVertexBuffer;
134    uint32_t mBufferID;
135
136    bool mUploadDefered;
137
138private:
139    void init(Context *rsc, const Type *);
140
141};
142
143}
144}
145#endif
146
147