diff --git a/.gitignore b/.gitignore index 65e0b0a..7473380 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /obj /libmonochrome.a +/libmonochrome_*.deb diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 54e2ee8..0012220 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,5 @@ # Contributing to libmonochrome -libmonochrome is a finished project by PierrotLL, and has been adapted to be used as a static library. It aims a full compatibility with addins using the 2011 version, so modifying is not a good idea, and adding may be inappropriate as it is a finished project. +libmonochrome is a finished project by PierrotLL, and has been adapted to be used as a static library. It aims a full compatibility with addins using the 2011 version, so modifying is not a good idea, and adding things to the source code may be inappropriate as it is a finished project. + +However, if you want to contribute to everything around it (like packaging stuff), your help is welcome :) diff --git a/LICENSE.md b/LICENSE.md index 86e6ba1..8200f43 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,3 +1,540 @@ -# libmonochrome is free software. +GNU General Public License +========================== -The only thing I could find about the license in the original files was "MonochromeLib is free software". So is libmonochrome. +_Version 3, 29 June 2007_ +_Copyright © 2007 Free Software Foundation, Inc. <>_ + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for software and other +kinds of works. + +The licenses for most software and other practical works are designed to take away +your freedom to share and change the works. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change all versions of a +program--to make sure it remains free software for all its users. We, the Free +Software Foundation, use the GNU General Public License for most of our software; it +applies also to any other work released this way by its authors. You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General +Public Licenses are designed to make sure that you have the freedom to distribute +copies of free software (and charge for them if you wish), that you receive source +code or can get it if you want it, that you can change the software or use pieces of +it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or +asking you to surrender the rights. Therefore, you have certain responsibilities if +you distribute copies of the software, or if you modify it: responsibilities to +respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, +you must pass on to the recipients the same freedoms that you received. You must make +sure that they, too, receive or can get the source code. And you must show them these +terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: **(1)** assert +copyright on the software, and **(2)** offer you this License giving you legal permission +to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is +no warranty for this free software. For both users' and authors' sake, the GPL +requires that modified versions be marked as changed, so that their problems will not +be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of +the software inside them, although the manufacturer can do so. This is fundamentally +incompatible with the aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we have designed +this version of the GPL to prohibit the practice for those products. If such problems +arise substantially in other domains, we stand ready to extend this provision to +those domains in future versions of the GPL, as needed to protect the freedom of +users. + +Finally, every program is threatened constantly by software patents. States should +not allow patents to restrict development and use of software on general-purpose +computers, but in those that do, we wish to avoid the special danger that patents +applied to a free program could make it effectively proprietary. To prevent this, the +GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in +a fashion requiring copyright permission, other than the making of an exact copy. The +resulting work is called a “modified version” of the earlier work or a +work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on +the Program. + +To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for infringement under +applicable copyright law, except executing it on a computer or modifying a private +copy. Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the +extent that it includes a convenient and prominently visible feature that **(1)** +displays an appropriate copyright notice, and **(2)** tells the user that there is no +warranty for the work (except to the extent that warranties are provided), that +licensees may convey the work under this License, and how to view a copy of this +License. If the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The “source code” for a work means the preferred form of the work for +making modifications to it. “Object code” means any non-source form of a +work. + +A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of interfaces +specified for a particular programming language, one that is widely used among +developers working in that language. + +The “System Libraries” of an executable work include anything, other than +the work as a whole, that **(a)** is included in the normal form of packaging a Major +Component, but which is not part of that Major Component, and **(b)** serves only to +enable use of the work with that Major Component, or to implement a Standard +Interface for which an implementation is available to the public in source code form. +A “Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system (if any) on which +the executable work runs, or a compiler used to produce the work, or an object code +interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the +source code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. However, +it does not include the work's System Libraries, or general-purpose tools or +generally available free programs which are used unmodified in performing those +activities but which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for the work, and +the source code for shared libraries and dynamically linked subprograms that the work +is specifically designed to require, such as by intimate data communication or +control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of copyright on the +Program, and are irrevocable provided the stated conditions are met. This License +explicitly affirms your unlimited permission to run the unmodified Program. The +output from running a covered work is covered by this License only if the output, +given its content, constitutes a covered work. This License acknowledges your rights +of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey covered +works to others for the sole purpose of having them make modifications exclusively +for you, or provide you with facilities for running those works, provided that you +comply with the terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for you must do so +exclusively on your behalf, under your direction and control, on terms that prohibit +them from making any copies of your copyrighted material outside their relationship +with you. + +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological measure under any +applicable law fulfilling obligations under article 11 of the WIPO copyright treaty +adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention +of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of +technological measures to the extent such circumvention is effected by exercising +rights under this License with respect to the covered work, and you disclaim any +intention to limit operation or modification of the work as a means of enforcing, +against the work's users, your or third parties' legal rights to forbid circumvention +of technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you receive it, in any +medium, provided that you conspicuously and appropriately publish on each copy an +appropriate copyright notice; keep intact all notices stating that this License and +any non-permissive terms added in accord with section 7 apply to the code; keep +intact all notices of the absence of any warranty; and give all recipients a copy of +this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer +support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to produce it from +the Program, in the form of source code under the terms of section 4, provided that +you also meet all of these conditions: + +* **a)** The work must carry prominent notices stating that you modified it, and giving a +relevant date. +* **b)** The work must carry prominent notices stating that it is released under this +License and any conditions added under section 7. This requirement modifies the +requirement in section 4 to “keep intact all notices”. +* **c)** You must license the entire work, as a whole, under this License to anyone who +comes into possession of a copy. This License will therefore apply, along with any +applicable section 7 additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no permission to license the +work in any other way, but it does not invalidate such permission if you have +separately received it. +* **d)** If the work has interactive user interfaces, each must display Appropriate Legal +Notices; however, if the Program has interactive interfaces that do not display +Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, which are +not by their nature extensions of the covered work, and which are not combined with +it such as to form a larger program, in or on a volume of a storage or distribution +medium, is called an “aggregate” if the compilation and its resulting +copyright are not used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work in an aggregate +does not cause this License to apply to the other parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms of sections 4 and +5, provided that you also convey the machine-readable Corresponding Source under the +terms of this License, in one of these ways: + +* **a)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by the Corresponding Source fixed on a +durable physical medium customarily used for software interchange. +* **b)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by a written offer, valid for at least +three years and valid for as long as you offer spare parts or customer support for +that product model, to give anyone who possesses the object code either **(1)** a copy of +the Corresponding Source for all the software in the product that is covered by this +License, on a durable physical medium customarily used for software interchange, for +a price no more than your reasonable cost of physically performing this conveying of +source, or **(2)** access to copy the Corresponding Source from a network server at no +charge. +* **c)** Convey individual copies of the object code with a copy of the written offer to +provide the Corresponding Source. This alternative is allowed only occasionally and +noncommercially, and only if you received the object code with such an offer, in +accord with subsection 6b. +* **d)** Convey the object code by offering access from a designated place (gratis or for +a charge), and offer equivalent access to the Corresponding Source in the same way +through the same place at no further charge. You need not require recipients to copy +the Corresponding Source along with the object code. If the place to copy the object +code is a network server, the Corresponding Source may be on a different server +(operated by you or a third party) that supports equivalent copying facilities, +provided you maintain clear directions next to the object code saying where to find +the Corresponding Source. Regardless of what server hosts the Corresponding Source, +you remain obligated to ensure that it is available for as long as needed to satisfy +these requirements. +* **e)** Convey the object code using peer-to-peer transmission, provided you inform +other peers where the object code and Corresponding Source of the work are being +offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from the +Corresponding Source as a System Library, need not be included in conveying the +object code work. + +A “User Product” is either **(1)** a “consumer product”, which +means any tangible personal property which is normally used for personal, family, or +household purposes, or **(2)** anything designed or sold for incorporation into a +dwelling. In determining whether a product is a consumer product, doubtful cases +shall be resolved in favor of coverage. For a particular product received by a +particular user, “normally used” refers to a typical or common use of +that class of product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected to use, the +product. A product is a consumer product regardless of whether the product has +substantial commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install and execute +modified versions of a covered work in that User Product from a modified version of +its Corresponding Source. The information must suffice to ensure that the continued +functioning of the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for +use in, a User Product, and the conveying occurs as part of a transaction in which +the right of possession and use of the User Product is transferred to the recipient +in perpetuity or for a fixed term (regardless of how the transaction is +characterized), the Corresponding Source conveyed under this section must be +accompanied by the Installation Information. But this requirement does not apply if +neither you nor any third party retains the ability to install modified object code +on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to +continue to provide support service, warranty, or updates for a work that has been +modified or installed by the recipient, or for the User Product in which it has been +modified or installed. Access to a network may be denied when the modification itself +materially and adversely affects the operation of the network or violates the rules +and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with +this section must be in a format that is publicly documented (and with an +implementation available to the public in source code form), and must require no +special password or key for unpacking, reading or copying. + +### 7. Additional Terms + +“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. Additional +permissions that are applicable to the entire Program shall be treated as though they +were included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part may be +used separately under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when you +modify the work.) You may place additional permissions on material, added by you to a +covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a +covered work, you may (if authorized by the copyright holders of that material) +supplement the terms of this License with terms: + +* **a)** Disclaiming warranty or limiting liability differently from the terms of +sections 15 and 16 of this License; or +* **b)** Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices displayed by works +containing it; or +* **c)** Prohibiting misrepresentation of the origin of that material, or requiring that +modified versions of such material be marked in reasonable ways as different from the +original version; or +* **d)** Limiting the use for publicity purposes of names of licensors or authors of the +material; or +* **e)** Declining to grant rights under trademark law for use of some trade names, +trademarks, or service marks; or +* **f)** Requiring indemnification of licensors and authors of that material by anyone +who conveys the material (or modified versions of it) with contractual assumptions of +liability to the recipient, for any liability that these contractual assumptions +directly impose on those licensors and authors. + +All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you received +it, or any part of it, contains a notice stating that it is governed by this License +along with a term that is a further restriction, you may remove that term. If a +license document contains a further restriction but permits relicensing or conveying +under this License, you may add to a covered work material governed by the terms of +that license document, provided that the further restriction does not survive such +relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in +the relevant source files, a statement of the additional terms that apply to those +files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a +separately written license, or stated as exceptions; the above requirements apply +either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly provided under +this License. Any attempt otherwise to propagate or modify it is void, and will +automatically terminate your rights under this License (including any patent licenses +granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a +particular copyright holder is reinstated **(a)** provisionally, unless and until the +copyright holder explicitly and finally terminates your license, and **(b)** permanently, +if the copyright holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, this +is the first time you have received notice of violation of this License (for any +work) from that copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of +parties who have received copies or rights from you under this License. If your +rights have been terminated and not permanently reinstated, you do not qualify to +receive new licenses for the same material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or run a copy of the +Program. Ancillary propagation of a covered work occurring solely as a consequence of +using peer-to-peer transmission to receive a copy likewise does not require +acceptance. However, nothing other than this License grants you permission to +propagate or modify any covered work. These actions infringe copyright if you do not +accept this License. Therefore, by modifying or propagating a covered work, you +indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically receives a license +from the original licensors, to run, modify and propagate that work, subject to this +License. You are not responsible for enforcing compliance by third parties with this +License. + +An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an organization, or +merging organizations. If propagation of a covered work results from an entity +transaction, each party to that transaction who receives a copy of the work also +receives whatever licenses to the work the party's predecessor in interest had or +could give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if the predecessor +has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or +affirmed under this License. For example, you may not impose a license fee, royalty, +or other charge for exercise of rights granted under this License, and you may not +initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging +that any patent claim is infringed by making, using, selling, offering for sale, or +importing the Program or any portion of it. + +### 11. Patents + +A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The work thus +licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or +controlled by the contributor, whether already acquired or hereafter acquired, that +would be infringed by some manner, permitted by this License, of making, using, or +selling its contributor version, but do not include claims that would be infringed +only as a consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant patent +sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license +under the contributor's essential patent claims, to make, use, sell, offer for sale, +import and otherwise run, modify and propagate the contents of its contributor +version. + +In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent (such as an +express permission to practice a patent or covenant not to sue for patent +infringement). To “grant” such a patent license to a party means to make +such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free of charge +and under the terms of this License, through a publicly available network server or +other readily accessible means, then you must either **(1)** cause the Corresponding +Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the +patent license for this particular work, or **(3)** arrange, in a manner consistent with +the requirements of this License, to extend the patent license to downstream +recipients. “Knowingly relying” means you have actual knowledge that, but +for the patent license, your conveying the covered work in a country, or your +recipient's use of the covered work in a country, would infringe one or more +identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you +convey, or propagate by procuring conveyance of, a covered work, and grant a patent +license to some of the parties receiving the covered work authorizing them to use, +propagate, modify or convey a specific copy of the covered work, then the patent +license you grant is automatically extended to all recipients of the covered work and +works based on it. + +A patent license is “discriminatory” if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on the +non-exercise of one or more of the rights that are specifically granted under this +License. You may not convey a covered work if you are a party to an arrangement with +a third party that is in the business of distributing software, under which you make +payment to the third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties who would receive +the covered work from you, a discriminatory patent license **(a)** in connection with +copies of the covered work conveyed by you (or copies made from those copies), or **(b)** +primarily for and in connection with specific products or compilations that contain +the covered work, unless you entered into that arrangement, or that patent license +was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available to you +under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or otherwise) +that contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot convey a covered work so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not convey it at all. For example, if you +agree to terms that obligate you to collect a royalty for further conveying from +those to whom you convey the Program, the only way you could satisfy both those terms +and this License would be to refrain entirely from conveying the Program. + +### 13. Use with the GNU Affero General Public License + +Notwithstanding any other provision of this License, you have permission to link or +combine any covered work with a work licensed under version 3 of the GNU Affero +General Public License into a single combined work, and to convey the resulting work. +The terms of this License will continue to apply to the part which is the covered +work, but the special requirements of the GNU Affero General Public License, section +13, concerning interaction through a network will apply to the combination as such. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions of the GNU +General Public License from time to time. Such new versions will be similar in spirit +to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that +a certain numbered version of the GNU General Public License “or any later +version” applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published by the +Free Software Foundation. If the Program does not specify a version number of the GNU +General Public License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU +General Public License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no +additional obligations are imposed on any author or copyright holder as a result of +your choosing to follow a later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE +QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY +COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE +OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE +WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided above cannot be +given local legal effect according to their terms, reviewing courts shall apply local +law that most closely approximates an absolute waiver of all civil liability in +connection with the Program, unless a warranty or assumption of liability accompanies +a copy of the Program in return for a fee. diff --git a/Makefile b/Makefile index dd0c15d..201762d 100644 --- a/Makefile +++ b/Makefile @@ -12,7 +12,13 @@ include $(CURDIR)/Makefile.cfg # DEDUCED VARIABLES ALLOBJ = $(SRC:%=$(OBJDIR)/%.o) -ALLINC = $(INC:%=$(INCDIR)/%.h) +ALLINC = $(INCPUB:%=$(INCDIR)/%.h) $(INCINT:%=$(INCDIR)/%.h) + +# STYLE VARS +define \n + + +endef # RULES ## Make everything (default) @@ -31,7 +37,7 @@ lib$(NAME).a: $(OBJDIR) $(ALLOBJ) $(AR) rc $@ $(ALLOBJ) $(RANLIB) $@ -## Clean the object files +## Clean the object files and compressed manpages clean: $(RM) $(ALLOBJ) @@ -42,7 +48,19 @@ fclean: clean ## Remake the project re: fclean all +## Package lib +package: lib$(NAME)_$(VERSION).deb +lib$(NAME)_$(VERSION).deb: lib$(NAME).a $(INCPUB:%=$(INCDIR)/%.h) + $(INST) -m 755 -d $(TGTRT)$(TGTDIR)/lib/$(NAME)/$(VERSION)/include + $(INST) -m 644 lib$(NAME).a $(TGTRT)$(TGTDIR)/lib/$(NAME)/$(VERSION) + $(foreach inc, $(INCPUB), \ + $(INST) -m 755 -d $(TGTRT)$(TGTDIR)/lib/$(NAME)/$(VERSION)/include/$(shell dirname $(inc).h)$(\n) + $(INST) -m 644 $(INCDIR)/$(inc).h $(TGTRT)$(TGTDIR)/lib/$(NAME)/$(VERSION)/include/$(shell dirname $(inc).h)$(\n)) + $(INST) -m 755 -d $(TGTRT)$(TGTMANDIR)/man3 + $(foreach man, $(MAN3), \ + $(INST) -m 644 $(MANDIR)/man3/$(man) $(TGTRT)$(TGTMANDIR)/man3$(\n)) + ## Doz rulz are phunny -.PHONY: all clean fclean re +.PHONY: all clean fclean re package install # END OF FILE diff --git a/Makefile.cfg b/Makefile.cfg index 102ac03..2c04a3b 100644 --- a/Makefile.cfg +++ b/Makefile.cfg @@ -8,13 +8,20 @@ # Last updated: 2016/04/21 22:15:56 |___/ # # # #******************************************************************************# -# PROJECT INFORMATION +# PROJECT INFORMATION (type: lib) NAME = monochrome +VERSION = 1.1 # DIRECTORIES +## PROJECT INCDIR = ./include SRCDIR = ./src OBJDIR = ./obj +MANDIR = ./man +## TARGET +TGTRT = debian/root +TGTDIR = /usr/cross +TGTMANDIR = /usr/share/man # SOURCE FILES SRC = ML_vram_adress \ @@ -36,7 +43,13 @@ SRC = ML_vram_adress \ ML_bmp_16_or_cl ML_bmp_16_and_cl ML_bmp_16_xor_cl # INCLUDE FILES -INC = monochrome monochrome/internals +## PUBLIC +INCPUB = monochrome +## INTERNALS +INCINT = monochrome/internals + +# MANPAGES +MAN3 = $(shell basename -a $$(find $(MANDIR)/man3 -type f) $$(find $(MANDIR)/man3 type l)) # BIN UTILITIES ## Platform @@ -52,5 +65,9 @@ RANLIB = $(PLATFORM)ranlib MKDIR = mkdir -p ## File remover RM = rm -f +## Gzip Compressor +GZP = gzip +## Installer +INST = /usr/bin/install # END OF FILE diff --git a/README.md b/README.md index 5e58f22..6c6a745 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,8 @@ Building the library is achieved by the Makefile : ## Using -To compile with the library, either : -- add the monochrome.h file to one of your include directories ; -- add the monochrome.h file with your sources and include it with the '#include "monochrome.h"' preprocessor directive ; -- add the include dir to your include path by adding '-I "path/to/dir/include"' to your compiler's flags. +Once installed, when linking a project, you will need to link with the library by adding the `-lmonochrome` flag. -To link with your project, either : -- add the libmonochrome.a to one of your static libraries directories ; -- add this library to your static libraries path by adding '-L "path/to/dir"' to your linker's flags. - -In either way, you will have to add '-lmonochrome' to your linker's flags. - -An example of using this library will then be : - - sh3eb-elf-gcc -c -o obj/main.o src/main.c -I lib/monochrome/include - sh3eb-elf-ld -o myaddin obj/main.o -T addin.ld -L lib/monochrome -lmonochrome +If you don't want to install the library : +- when compiling, you should add `-I path/to/this/dir/include`. +- when linking, you should add `-L path/to/this/dir`. diff --git a/debian/.gitignore b/debian/.gitignore new file mode 100644 index 0000000..cd3d018 --- /dev/null +++ b/debian/.gitignore @@ -0,0 +1 @@ +/root diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..5725520 --- /dev/null +++ b/debian/control @@ -0,0 +1,12 @@ +Source: libmonochrome +Priority: optional +Section: libs +Maintainer: Thomas "CakeIsALie5" Touhey +Uploader: Thomas "CakeIsALie5" Touhey +Standards-Version: 3.9.6 +Vcs-Browser: http://git.planet-casio.com/cakeisalie5/libmonochrome.git +Homepage: http://git.planet-casio.com/cakeisalie5/libmonochrome + +Package: libmonochrome-dev +Architecture: any +Description: Fast and efficient drawing static library for CASIO fx calculators. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..4306be5 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,26 @@ +Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: libmonochrome +Upstream-Contact: Thomas Touhey +Source: http://git.planet-casio.com/cakeisalie5/libmonochrome + +Files: * +Copyright: © 2011 Pierre "PierrotLL" Le Gall +License: GPL-3+ + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + . + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + . + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Files: Makefile* + debian/* +Copyright: © 2016 Thomas "CakeIsALie5" Touhey +License: Same + Same as libmonochrome itself diff --git a/debian/docs b/debian/docs new file mode 100644 index 0000000..b43bf86 --- /dev/null +++ b/debian/docs @@ -0,0 +1 @@ +README.md diff --git a/man/man3/libmonochrome.3 b/man/man3/libmonochrome.3 new file mode 100644 index 0000000..26f000f --- /dev/null +++ b/man/man3/libmonochrome.3 @@ -0,0 +1,34 @@ +.TH libmonochrome 3 +.SH NAME +libmonochrome - fast and efficient drawing library for CASIO monochrome calculators + +.SH SYNOPSIS +.B #include + +.B ML_clear_vram(); + +.B ML_line(0, 0, 127, 63); + +.B ML_line(127, 0, 0, 63); + +.B ML_display_vram(); + +.SH DESCRIPTION +libmonochrome provides tools to work with the VRAM and the Display Driver. + +.SH SEE ALSO +.BR ML_vram(3), +.BR ML_contrast(3), +.BR ML_Color(3), +.BR ML_pixel(3), +.BR ML_point(3), +.BR ML_line(3), +.BR ML_rectangle(3), +.BR ML_polygon(3), +.BR ML_circle(3), +.BR ML_ellipse(3), +.BR ML_scroll(3), +.BR ML_bmp(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_bmp.3 b/man/man3/ml_bmp.3 new file mode 100644 index 0000000..007a574 --- /dev/null +++ b/man/man3/ml_bmp.3 @@ -0,0 +1,58 @@ +.TH ML_bmp 3 +.SH NAME +ML_bmp - BMP drawing functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_bmp_or(const unsigned char *bmp, int x, int y, int width, int height); + +.B void ML_bmp_and(const unsigned char *bmp, int x, int y, int width, int height); + +.B void ML_bmp_xor(const unsigned char *bmp, int x, int y, int width, int height); + +.B void ML_bmp_or_cl(const unsigned char *bmp, int x, int y, int width, int height); + +.B void ML_bmp_and_cl(const unsigned char *bmp, int x, int y, int width, int height); + +.B void ML_bmp_xor_cl(const unsigned char *bmp, int x, int y, int width, int height); + + +.B void ML_bmp_8_or(const unsigned char *bmp, int x, int y); + +.B void ML_bmp_8_and(const unsigned char *bmp, int x, int y); + +.B void ML_bmp_8_xor(const unsigned char *bmp, int x, int y); + +.B void ML_bmp_8_or_cl(const unsigned char *bmp, int x, int y); + +.B void ML_bmp_8_and_cl(const unsigned char *bmp, int x, int y); + +.B void ML_bmp_8_xor_cl(const unsigned char *bmp, int x, int y); + + +.B void ML_bmp_16_or(const unsigned short *bmp, int x, int y); + +.B void ML_bmp_16_and(const unsigned short *bmp, int x, int y); + +.B void ML_bmp_16_xor(const unsigned short *bmp, int x, int y); + +.B void ML_bmp_16_or_cl(const unsigned short *bmp, int x, int y); + +.B void ML_bmp_16_and_cl(const unsigned short *bmp, int x, int y); + +.B void ML_bmp_16_xor_cl(const unsigned short *bmp, int x, int y); + +.SH DESCRIPTION +Those functions are meant to draw monochrome with fill bits bitmaps -- like game sprites -- on the VRAM. + +Functions starting with the ML_bmp_8 draw 8*8 bitmaps. Functions starting with ML_bmp_16 draw 16*16 bitmaps. All other images must be drawn with the the other functions. + +Function with the _cl suffix are functions using clipping, which means they are able to draw sprites even if they aren't completely on screen. Other functions only draw the bitmap if it is in the screen -- which makes them a little faster. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_bmp_16_and.3 b/man/man3/ml_bmp_16_and.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_16_and.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_16_and_cl.3 b/man/man3/ml_bmp_16_and_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_16_and_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_16_or.3 b/man/man3/ml_bmp_16_or.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_16_or.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_16_or_cl.3 b/man/man3/ml_bmp_16_or_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_16_or_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_16_xor.3 b/man/man3/ml_bmp_16_xor.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_16_xor.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_16_xor_cl.3 b/man/man3/ml_bmp_16_xor_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_16_xor_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_8_and.3 b/man/man3/ml_bmp_8_and.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_8_and.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_8_and_cl.3 b/man/man3/ml_bmp_8_and_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_8_and_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_8_or.3 b/man/man3/ml_bmp_8_or.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_8_or.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_8_or_cl.3 b/man/man3/ml_bmp_8_or_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_8_or_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_8_xor.3 b/man/man3/ml_bmp_8_xor.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_8_xor.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_8_xor_cl.3 b/man/man3/ml_bmp_8_xor_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_8_xor_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_and.3 b/man/man3/ml_bmp_and.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_and.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_and_cl.3 b/man/man3/ml_bmp_and_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_and_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_or.3 b/man/man3/ml_bmp_or.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_or.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_or_cl.3 b/man/man3/ml_bmp_or_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_or_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_xor.3 b/man/man3/ml_bmp_xor.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_xor.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_bmp_xor_cl.3 b/man/man3/ml_bmp_xor_cl.3 new file mode 120000 index 0000000..7aeb7ad --- /dev/null +++ b/man/man3/ml_bmp_xor_cl.3 @@ -0,0 +1 @@ +ml_bmp.3 \ No newline at end of file diff --git a/man/man3/ml_circle.3 b/man/man3/ml_circle.3 new file mode 100644 index 0000000..6b09d64 --- /dev/null +++ b/man/man3/ml_circle.3 @@ -0,0 +1,21 @@ +.TH ML_circle 3 +.SH NAME +ML_circle - Circles drawing functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_circle(int x, int y, int radius, ML_Color color); + +.B void ML_filled_circle(int x, int y, int radius, ML_Color color); + +.SH DESCRIPTION +Those functions draw a circle on the VRAM. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3), +.BR ML_Color(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_clear_screen.3 b/man/man3/ml_clear_screen.3 new file mode 120000 index 0000000..2ba6d59 --- /dev/null +++ b/man/man3/ml_clear_screen.3 @@ -0,0 +1 @@ +ml_vram.3 \ No newline at end of file diff --git a/man/man3/ml_clear_vram.3 b/man/man3/ml_clear_vram.3 new file mode 120000 index 0000000..2ba6d59 --- /dev/null +++ b/man/man3/ml_clear_vram.3 @@ -0,0 +1 @@ +ml_vram.3 \ No newline at end of file diff --git a/man/man3/ml_color.3 b/man/man3/ml_color.3 new file mode 100644 index 0000000..6c331bb --- /dev/null +++ b/man/man3/ml_color.3 @@ -0,0 +1,31 @@ +.TH ML_Color 3 +.SH NAME +ML_Color - Colors from libmonochrome + +.SH SYNOPSIS +.B #include +.in n +.nf + +typedef enum { + ML_TRANSPARENT = -1, + ML_WHITE, + ML_BLACK, + ML_XOR, + ML_CHECKER +} ML_Color; +.fi + +.SH DESCRIPTION +ML_Color is an enumeration of the different colors used by libmonochrome. + +ML_XOR reverses the color of drawn-on pixels in the VRAM. + +ML_CHECKER is a "checker" color. It renders a pixel white or black according to the following rule : if (x and y are even) or (x and y are odd), then the pixel becomes black, otherwise it becomes white. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_contrast.3 b/man/man3/ml_contrast.3 new file mode 100644 index 0000000..0afc262 --- /dev/null +++ b/man/man3/ml_contrast.3 @@ -0,0 +1,25 @@ +.TH ML_Contrast 3 +.SH NAME +ML_Contrast - Screen contrast setting functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B #define ML_CONTRAST_MIN 130 + +.B #define ML_CONTRAST_NORMAL 168 + +.B #define ML_CONTRAST_MAX 190 + +.B void ML_set_contrast(unsigned char contrast); + +.B unsigned char ML_get_contrast(); + +.SH DESCRIPTION +Those functions set the contrast of the screen. This contrast must be greater than ML_CONTRAST_MIN and lesser then ML_CONTRAST_MAX. + +.SH SEE ALSO +.BR libmonochrome(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_display_vram.3 b/man/man3/ml_display_vram.3 new file mode 120000 index 0000000..2ba6d59 --- /dev/null +++ b/man/man3/ml_display_vram.3 @@ -0,0 +1 @@ +ml_vram.3 \ No newline at end of file diff --git a/man/man3/ml_ellipse.3 b/man/man3/ml_ellipse.3 new file mode 100644 index 0000000..8c59f79 --- /dev/null +++ b/man/man3/ml_ellipse.3 @@ -0,0 +1,25 @@ +.TH ML_ellipse 3 +.SH NAME +ML_ellipse - Ellipses drawing functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_ellipse(int x, int y, int radius1, int radius2, ML_Color color); + +.B void ML_filled_ellipse(int x, int y, int radius1, int radius2, ML_Color color); + +.B void ML_ellipse_in_rect(int x1, int y1, int x2, int y2, ML_Color color); + +.B void ML_filled_ellipse_in_rect(int x, int y, int radius1, int radius2, ML_Color color); + +.SH DESCRIPTION +These functions draw an ellipse in the VRAM. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3), +.BR ML_Color(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_ellipse_in_rect.3 b/man/man3/ml_ellipse_in_rect.3 new file mode 120000 index 0000000..ca9d2a6 --- /dev/null +++ b/man/man3/ml_ellipse_in_rect.3 @@ -0,0 +1 @@ +ml_ellipse.3 \ No newline at end of file diff --git a/man/man3/ml_filled_circle.3 b/man/man3/ml_filled_circle.3 new file mode 120000 index 0000000..b9bb5f9 --- /dev/null +++ b/man/man3/ml_filled_circle.3 @@ -0,0 +1 @@ +ml_circle.3 \ No newline at end of file diff --git a/man/man3/ml_filled_ellipse.3 b/man/man3/ml_filled_ellipse.3 new file mode 120000 index 0000000..ca9d2a6 --- /dev/null +++ b/man/man3/ml_filled_ellipse.3 @@ -0,0 +1 @@ +ml_ellipse.3 \ No newline at end of file diff --git a/man/man3/ml_filled_ellipse_in_rect.3 b/man/man3/ml_filled_ellipse_in_rect.3 new file mode 120000 index 0000000..ca9d2a6 --- /dev/null +++ b/man/man3/ml_filled_ellipse_in_rect.3 @@ -0,0 +1 @@ +ml_ellipse.3 \ No newline at end of file diff --git a/man/man3/ml_filled_polygon.3 b/man/man3/ml_filled_polygon.3 new file mode 120000 index 0000000..d304e15 --- /dev/null +++ b/man/man3/ml_filled_polygon.3 @@ -0,0 +1 @@ +ml_polygon.3 \ No newline at end of file diff --git a/man/man3/ml_get_contrast.3 b/man/man3/ml_get_contrast.3 new file mode 120000 index 0000000..449f1af --- /dev/null +++ b/man/man3/ml_get_contrast.3 @@ -0,0 +1 @@ +ml_contrast.3 \ No newline at end of file diff --git a/man/man3/ml_horizontal_line.3 b/man/man3/ml_horizontal_line.3 new file mode 120000 index 0000000..6f69312 --- /dev/null +++ b/man/man3/ml_horizontal_line.3 @@ -0,0 +1 @@ +ml_line.3 \ No newline at end of file diff --git a/man/man3/ml_horizontal_scroll.3 b/man/man3/ml_horizontal_scroll.3 new file mode 120000 index 0000000..9d7ac07 --- /dev/null +++ b/man/man3/ml_horizontal_scroll.3 @@ -0,0 +1 @@ +ml_scroll.3 \ No newline at end of file diff --git a/man/man3/ml_line.3 b/man/man3/ml_line.3 new file mode 100644 index 0000000..75cc5d3 --- /dev/null +++ b/man/man3/ml_line.3 @@ -0,0 +1,25 @@ +.TH ML_line 3 +.SH NAME +ML_line - Line drawing functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_line(int x1, int y1, int x2, int y2, ML_Color color); + +.B void ML_horizontal_line(int y, int x1, int x2, ML_Color color); + +.B void ML_vertical_line(int x, int y1, int y2, ML_Color color); + +.SH DESCRIPTION +These functions draw lines on the VRAM. + +For horizontal line drawing, the ML_horizontal_line function is faster than ML_line, which has a general algorithm (the Bresenham algorithm). + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3), +.BR ML_Color(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_pixel.3 b/man/man3/ml_pixel.3 new file mode 100644 index 0000000..c58e170 --- /dev/null +++ b/man/man3/ml_pixel.3 @@ -0,0 +1,23 @@ +.TH ML_pixel 3 +.SH NAME +ML_pixel - Pixel setting and testing functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_pixel(int x, int y, ML_Color color); + +.B ML_Color ML_pixel_test(int x, int y); + +.SH DESCRIPTION +Sets or test (get) a pixel's state/color. + +For ML_pixel_test, if the asked pixel is out of the screen, the returned color will be ML_TRANSPARENT. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3), +.BR ML_Color(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_pixel_test.3 b/man/man3/ml_pixel_test.3 new file mode 120000 index 0000000..666c695 --- /dev/null +++ b/man/man3/ml_pixel_test.3 @@ -0,0 +1 @@ +ml_pixel.3 \ No newline at end of file diff --git a/man/man3/ml_point.3 b/man/man3/ml_point.3 new file mode 100644 index 0000000..da15810 --- /dev/null +++ b/man/man3/ml_point.3 @@ -0,0 +1,19 @@ +.TH ML_point 3 +.SH NAME +ML_point - Point drawing function from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_point(int x, int y, int width, ML_Color color); + +.SH DESCRIPTION +Draws a (square) point on the VRAM. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3), +.BR ML_Color(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_polygon.3 b/man/man3/ml_polygon.3 new file mode 100644 index 0000000..edbf094 --- /dev/null +++ b/man/man3/ml_polygon.3 @@ -0,0 +1,21 @@ +.TH ML_polygon 3 +.SH NAME +ML_polygon - Polygon drawing functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_polygon(const int *x, const int *y, int nb_vertices, ML_Color color); + +.B void ML_filled_polygon(const int *x, const int *y, int nb_vertices, ML_Color color); + +.SH DESCRIPTION +Draws a polygon on the VRAM. This function needs as parameter 2 arrays, containing abscissa and ordinates of the polygon vertices. Parameter nb_vertices should be the number of data to read in arrays. This function draws a line between each vertices in the polygon. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3), +.BR ML_Color(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_rectangle.3 b/man/man3/ml_rectangle.3 new file mode 100644 index 0000000..665330d --- /dev/null +++ b/man/man3/ml_rectangle.3 @@ -0,0 +1,19 @@ +.TH ML_rectangle 3 +.SH NAME +ML_rectangle - Rectangle drawing function from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_rectangle(int x1, int y1, int x2, int y2, int border_width, ML_Color border_color, ML_Color fill_color); + +.SH DESCRIPTION +Draws a rectangle with or without border on the VRAM. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3), +.BR ML_Color(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_screen.3 b/man/man3/ml_screen.3 new file mode 120000 index 0000000..2ba6d59 --- /dev/null +++ b/man/man3/ml_screen.3 @@ -0,0 +1 @@ +ml_vram.3 \ No newline at end of file diff --git a/man/man3/ml_scroll.3 b/man/man3/ml_scroll.3 new file mode 100644 index 0000000..f32fbbf --- /dev/null +++ b/man/man3/ml_scroll.3 @@ -0,0 +1,23 @@ +.TH ML_scroll 3 +.SH NAME +ML_scroll - VRAM scrolling functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B void ML_horizontal_scroll(int scroll); + +.B void ML_vertical_scroll(int scroll); + +.SH DESCRIPTION +Shifts all the pixels of the VRAM from left to right or from top to bottom. If scroll's value is negative, the pixels will be shifted from right to left or from bottom to top. + +When pixels reach screen boundaries, they are moved to the other side. + +.SH SEE ALSO +.BR libmonochrome(3), +.BR ML_VRAM(3), +.BR ML_Color(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_set_contrast.3 b/man/man3/ml_set_contrast.3 new file mode 120000 index 0000000..449f1af --- /dev/null +++ b/man/man3/ml_set_contrast.3 @@ -0,0 +1 @@ +ml_contrast.3 \ No newline at end of file diff --git a/man/man3/ml_vertical_line.3 b/man/man3/ml_vertical_line.3 new file mode 120000 index 0000000..6f69312 --- /dev/null +++ b/man/man3/ml_vertical_line.3 @@ -0,0 +1 @@ +ml_line.3 \ No newline at end of file diff --git a/man/man3/ml_vertical_scroll.3 b/man/man3/ml_vertical_scroll.3 new file mode 120000 index 0000000..9d7ac07 --- /dev/null +++ b/man/man3/ml_vertical_scroll.3 @@ -0,0 +1 @@ +ml_scroll.3 \ No newline at end of file diff --git a/man/man3/ml_vram.3 b/man/man3/ml_vram.3 new file mode 100644 index 0000000..8c0bce0 --- /dev/null +++ b/man/man3/ml_vram.3 @@ -0,0 +1,29 @@ +.TH ML_VRAM 3 +.SH NAME +ML_VRAM - Video RAM and Display Driver management functions from libmonochrome + +.SH SYNOPSIS +.B #include + +.B char* ML_vram_adress(); + +.B void ML_clear_vram(); + +.B void ML_clear_screen(); + +.B void ML_display_vram(); + +.SH DESCRIPTION +libmonochrome uses natively a double-buffering technique : the user program draws on a working space, the VRAM, and when he finished drawing the frame, this frame is sent to the Display Driver so it can appear on the screen. + +ML_vram_adress is a system call that returns the address of the VRAM allocated by the system. It is mainly meant for internal purposes, but if you want to use the VRAM directly, you can use it. + +ML_clear_screen sends a bunch of zeros to the Display Driver so the screen content gets erased, but the VRAM stays as it is. ML_clear_vram does the opposite : it clears the VRAM content while leaving the screen's one. + +ML_display_vram sends the VRAM content to the Display Driver, so it can appear on the screen. + +.SH SEE ALSO +.BR libmonochrome(3) + +.SH AUTHOR +Copyright (C) 2016 by Thomas "CakeIsALie5" Touhey. diff --git a/man/man3/ml_vram_adress.3 b/man/man3/ml_vram_adress.3 new file mode 120000 index 0000000..2ba6d59 --- /dev/null +++ b/man/man3/ml_vram_adress.3 @@ -0,0 +1 @@ +ml_vram.3 \ No newline at end of file