rsAllocation.h revision 84e4027f83b20af59f5b1fc52be6e45f159d3970 
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    // The graphics equilivent of malloc.  The allocation contains a structure of elements.
30
31public:
32    Allocation(Context *rsc, const Type *);
33    Allocation(Context *rsc, const Type *, void *bmp, void *callbackData, RsBitmapCallback_t callback);
34
35    virtual ~Allocation();
36
37    void setCpuWritable(bool);
38    void setGpuWritable(bool);
39    void setCpuReadable(bool);
40    void setGpuReadable(bool);
41
42    bool fixAllocation();
43
44    void * getPtr() const {return mPtr;}
45    const Type * getType() const {return mType.get();}
46
47    void deferedUploadToTexture(const Context *rsc, bool genMipmap, uint32_t lodOffset);
48    void uploadToTexture(const Context *rsc);
49    uint32_t getTextureID() const {return mTextureID;}
50
51    uint32_t getGLTarget() const;
52
53    void deferedUploadToBufferObject(const Context *rsc);
54    void uploadToBufferObject(const Context *rsc);
55    uint32_t getBufferObjectID() const {return mBufferID;}
56
57    void copyRange1D(Context *rsc, const Allocation *src, int32_t srcOff, int32_t destOff, int32_t len);
58
59    void resize1D(Context *rsc, uint32_t dimX);
60    void resize2D(Context *rsc, uint32_t dimX, uint32_t dimY);
61
62    void data(Context *rsc, const void *data, uint32_t sizeBytes);
63    void subData(Context *rsc, uint32_t xoff, uint32_t count, const void *data, uint32_t sizeBytes);
64    void subData(Context *rsc, uint32_t xoff, uint32_t yoff,
65                 uint32_t w, uint32_t h, const void *data, uint32_t sizeBytes);
66    void subData(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff,
67                 uint32_t w, uint32_t h, uint32_t d, const void *data, uint32_t sizeBytes);
68
69    void subElementData(Context *rsc, uint32_t x,
70                        const void *data, uint32_t elementOff, uint32_t sizeBytes);
71    void subElementData(Context *rsc, uint32_t x, uint32_t y,
72                        const void *data, uint32_t elementOff, uint32_t sizeBytes);
73
74    void read(void *data);
75
76    void enableGLVertexBuffers() const;
77    void setupGLIndexBuffers() const;
78
79    void addProgramToDirty(const Program *);
80    void removeProgramToDirty(const Program *);
81
82    virtual void dumpLOGV(const char *prefix) const;
83    virtual void serialize(OStream *stream) const;
84    virtual RsA3DClassID getClassId() const { return RS_A3D_CLASS_ID_ALLOCATION; }
85    static Allocation *createFromStream(Context *rsc, IStream *stream);
86
87    virtual void uploadCheck(const Context *rsc);
88
89    bool getIsTexture() const {return mIsTexture;}
90    bool getIsBufferObject() const {return mIsVertexBuffer;}
91
92    void incRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
93    void decRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
94
95    void sendDirty() const;
96    bool getHasGraphicsMipmaps() const {return mTextureGenMipmap;}
97
98protected:
99    ObjectBaseRef<const Type> mType;
100    void * mPtr;
101
102    Vector<const Program *> mToDirtyList;
103
104    // Is we have a non-null user bitmap callback we do not own the bits and
105    // instead call this function to free the memort when its time.
106    RsBitmapCallback_t mUserBitmapCallback;
107    void *mUserBitmapCallbackData;
108
109    // Usage restrictions
110    bool mCpuWrite;
111    bool mCpuRead;
112    bool mGpuWrite;
113    bool mGpuRead;
114
115    // more usage hint data from the application
116    // which can be used by a driver to pick the best memory type.
117    // Likely ignored for now
118    float mReadWriteRatio;
119    float mUpdateSize;
120
121
122    // Is this a legal structure to be used as a texture source.
123    // Initially this will require 1D or 2D and color data
124    bool mIsTexture;
125    bool mTextureGenMipmap;
126    uint32_t mTextureLOD;
127    uint32_t mTextureID;
128
129    // Is this a legal structure to be used as a vertex source.
130    // Initially this will require 1D and x(yzw).  Additional per element data
131    // is allowed.
132    bool mIsVertexBuffer;
133    uint32_t mBufferID;
134
135    bool mUploadDefered;
136
137private:
138    void init(Context *rsc, const Type *);
139    void upload2DTexture(bool isFirstUpload);
140    void uploadCubeTexture(bool isFirstUpload);
141};
142
143}
144}
145#endif
146
147