X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fbufferable.h;h=86c5c77fc4d39226295c3e442903eb476e85de1b;hb=5f78db03b3285c977760a41da1e3927720e50352;hp=fa81554dd0090be867ddfc6ca905c6c68ab5d790;hpb=f6e51c2f771726eec73b07824ebde2cf8bd522f0;p=libs%2Fgl.git diff --git a/source/bufferable.h b/source/bufferable.h index fa81554d..86c5c77f 100644 --- a/source/bufferable.h +++ b/source/bufferable.h @@ -6,31 +6,91 @@ namespace GL { class Buffer; +/** +Base class for things that can store data in buffers. Supports buffer sharing. +A dirty flag is provided for derived classes. It should be set when the data +in the buffer is considered out of date, and is cleared by Bufferable after +uploading fresh data to the buffer. +*/ class Bufferable { -protected: +public: + class AsyncUpdater + { + private: + const Bufferable &bufferable; + char *mapped_address; + + public: + AsyncUpdater(const Bufferable &); + ~AsyncUpdater(); + + void upload_data(); + }; + +private: Buffer *buffer; - unsigned buffer_offset; + unsigned offset; Bufferable *next_in_buffer; Bufferable *prev_in_buffer; + mutable bool location_dirty; +protected: mutable bool dirty; Bufferable(); public: virtual ~Bufferable(); - void use_buffer(Buffer *, Bufferable * = 0); + /** Sets the buffer to use. If prev is not null, it must use the same + buffer, and this object is inserted after it. */ + void use_buffer(Buffer *buf, Bufferable *prev = 0); + + /** Informs the objects in this chain that the buffer has been resized and + data should be reuploaded. */ + void buffer_resized(); + + /** Returns the total amount of storage required by this object and others + in the same chain, including any alignment between objects. */ + unsigned get_required_buffer_size() const; + + /** Uploads new data into the buffer if necessary. */ + void refresh() const { if(buffer && dirty) upload_data(0); } + + AsyncUpdater *refresh_async() const; + private: void unlink_from_buffer(); +public: + /** Returns the buffer in which the data is stored. */ + const Buffer *get_buffer() const { return buffer; } + protected: + /** Returns the amount of data to be stored in the buffer, in bytes. */ virtual unsigned get_data_size() const = 0; - void update_buffer_offset(); - virtual void offset_changed() { } + /** Returns a pointer to the start of data in client memory. */ + virtual const void *get_data_pointer() const = 0; + + /** Returns the alignment required for the data, in bytes. The offset is + guaranteed to be a multiple of this. */ + virtual unsigned get_alignment() const { return 1; } - void update_buffer_data() const; - virtual void upload_data() const = 0; + /** Updates the offsets for the chain so that data from different objects + does not overlap. Should be called if either data size or alignment + changes. */ + void update_offset(); + + /** Returns the offset where the data should be uploaded. */ + unsigned get_offset() const { return offset; } + + /** Called when the target buffer or offset within it has changed. */ + virtual void location_changed(Buffer *, unsigned, unsigned) const { } + +private: + /** Uploads data to the buffer. Receives pointer to mapped buffer memory as + parameter. If null, buffer interface should be used instead. */ + void upload_data(char *) const; }; } // namespace GL