diff options
| author | Richard Qin <richard.qin.x@gmail.com> | 2026-03-09 21:49:43 +0800 |
|---|---|---|
| committer | Richard Qin <richard.qin.x@gmail.com> | 2026-03-09 21:49:43 +0800 |
| commit | 7aa2a67d8381c9a88d69a3f53d74a7f079214263 (patch) | |
| tree | de149b622a960ffc42bfce1d6a37a81ea3a493a2 | |
| parent | 2a65ece16cd237d56c9dac8d9d3d680e9d34b774 (diff) | |
| download | ray-tracing-7aa2a67d8381c9a88d69a3f53d74a7f079214263.tar.gz ray-tracing-7aa2a67d8381c9a88d69a3f53d74a7f079214263.tar.xz | |
Establish a well-structured modern C++ project architecture
Focus on code quality: Treat strict warnings as errors, memory checks with Sanitizers, Clang formatting and static analysis
Performance optimization: LTO, ccache
| -rw-r--r-- | .clang-format | 23 | ||||
| -rw-r--r-- | .clang-tidy | 9 | ||||
| -rw-r--r-- | CMakeLists.txt | 39 | ||||
| -rw-r--r-- | LICENSE | 674 | ||||
| -rw-r--r-- | Makefile | 249 | ||||
| -rw-r--r-- | README.md | 45 | ||||
| -rw-r--r-- | apps/CMakeLists.txt | 3 | ||||
| -rw-r--r-- | apps/main.cc | 42 | ||||
| -rw-r--r-- | color.cc | 15 | ||||
| -rw-r--r-- | color.h | 12 | ||||
| -rw-r--r-- | etc/build_type.cmake | 11 | ||||
| -rw-r--r-- | etc/ccache.cmake | 5 | ||||
| -rw-r--r-- | etc/cflags.cmake | 16 | ||||
| -rw-r--r-- | etc/lto.cmake | 8 | ||||
| -rw-r--r-- | etc/scanners.cmake | 52 | ||||
| -rw-r--r-- | images/image.ppm (renamed from image.ppm) | 0 | ||||
| -rw-r--r-- | main.cc | 25 | ||||
| -rwxr-xr-x | scripts/make-parallel.sh | 2 | ||||
| -rw-r--r-- | src/CMakeLists.txt | 8 | ||||
| -rw-r--r-- | src/color.cc | 32 | ||||
| -rw-r--r-- | src/color.h | 28 | ||||
| -rw-r--r-- | src/vec3.cc | 132 | ||||
| -rw-r--r-- | src/vec3.h (renamed from vec3.h) | 19 | ||||
| -rw-r--r-- | vec3.cc | 105 |
24 files changed, 1395 insertions, 159 deletions
diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..c49e66b --- /dev/null +++ b/.clang-format @@ -0,0 +1,23 @@ +--- +Language: Cpp +BasedOnStyle: Mozilla +ColumnLimit: 116 +SpacesInParentheses: true +AlwaysBreakAfterReturnType: None +AlwaysBreakAfterDefinitionReturnType: None +SpaceBeforeCpp11BracedList: true +BreakBeforeBinaryOperators: All +Cpp11BracedListStyle: true +AllowShortBlocksOnASingleLine: Always +BreakBeforeBraces: Custom +BraceWrapping: + AfterClass: true + AfterControlStatement: Never + AfterFunction: true + AfterStruct: true + AfterEnum: true + SplitEmptyFunction: false + SplitEmptyRecord: false + SplitEmptyNamespace: false +PackConstructorInitializers: NextLine +... diff --git a/.clang-tidy b/.clang-tidy new file mode 100644 index 0000000..c1d3e9f --- /dev/null +++ b/.clang-tidy @@ -0,0 +1,9 @@ +Checks: + '*,-altera-*,-llvmlibc-*,-google-build-using-namespace,-modernize-use-trailing-return-type,-readability-implicit-bool-conversion,-*-non-private-member-variables-in-classes,-modernize-use-nodiscard,-*-magic-numbers,-readability-identifier-length,-concurrency-mt-unsafe,-llvm-header-guard,-fuchsia-default-arguments-calls,-fuchsia-default-arguments-declarations,-fuchsia-overloaded-operator,-android-cloexec-accept,-cppcoreguidelines-pro-type-vararg,-hicpp-vararg,-hicpp-signed-bitwise,-misc-include-cleaner,-readability-redundant-member-init,-boost-use-ranges,-portability-template-virtual-member-function' + +WarningsAsErrors: + '*' + +CheckOptions: + hicpp-special-member-functions.AllowSoleDefaultDtor: true + cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor: true diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..c001585 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,39 @@ +cmake_minimum_required(VERSION 3.24.2) + +project(RayTracer LANGUAGES CXX) + +set(CMAKE_CXX_STANDARD_REQUIRED True) + +if(${CMAKE_GENERATOR} STREQUAL "Unix Makefiles") + set(CMAKE_MAKE_PROGRAM "${PROJECT_SOURCE_DIR}/scripts/make-parallel.sh" CACHE STRING "" FORCE) +endif() + +if(${PROJECT_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR}) + message(FATAL_ERROR "RayTracer must be built outside its source directory, e.g. `cmake -B build`.") +endif() + +# Default is set to Release if not specified +include(${PROJECT_SOURCE_DIR}/etc/build_type.cmake) + +# Enable LTO +include(${PROJECT_SOURCE_DIR}/etc/lto.cmake) + +# Enable ccache +include(${PROJECT_SOURCE_DIR}/etc/ccache.cmake) + + +# strict compile warnings +include(${PROJECT_SOURCE_DIR}/etc/cflags.cmake) + +# clang-format clang-tidy + +include(${PROJECT_SOURCE_DIR}/etc/scanners.cmake) + +# ctest +# include(${PROJECT_SOURCE_DIR}/etc/ctest.cmake) + +# License +install(FILES LICENSE DESTINATION .) + +add_subdirectory("${PROJECT_SOURCE_DIR}/src") +add_subdirectory("${PROJECT_SOURCE_DIR}/apps")
\ No newline at end of file @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8809176 --- /dev/null +++ b/Makefile @@ -0,0 +1,249 @@ +# CMAKE generated file: DO NOT EDIT! +# Generated by "Unix Makefiles" Generator, CMake Version 3.28 + +# Default target executed when no arguments are given to make. +default_target: all +.PHONY : default_target + +# Allow only one "make -f Makefile2" at a time, but pass parallelism. +.NOTPARALLEL: + +#============================================================================= +# Special targets provided by cmake. + +# Disable implicit rules so canonical targets will work. +.SUFFIXES: + +# Disable VCS-based implicit rules. +% : %,v + +# Disable VCS-based implicit rules. +% : RCS/% + +# Disable VCS-based implicit rules. +% : RCS/%,v + +# Disable VCS-based implicit rules. +% : SCCS/s.% + +# Disable VCS-based implicit rules. +% : s.% + +.SUFFIXES: .hpux_make_needs_suffix_list + +# Command-line flag to silence nested $(MAKE). +$(VERBOSE)MAKESILENT = -s + +#Suppress display of executed commands. +$(VERBOSE).SILENT: + +# A target that is always out of date. +cmake_force: +.PHONY : cmake_force + +#============================================================================= +# Set environment variables for the build. + +# The shell in which to execute make rules. +SHELL = /bin/sh + +# The CMake executable. +CMAKE_COMMAND = /usr/bin/cmake + +# The command to remove a file. +RM = /usr/bin/cmake -E rm -f + +# Escaping for special characters. +EQUALS = = + +# The top-level source directory on which CMake was run. +CMAKE_SOURCE_DIR = /home/richard/code/ray-tracing + +# The top-level build directory on which CMake was run. +CMAKE_BINARY_DIR = /home/richard/code/ray-tracing + +#============================================================================= +# Targets provided globally by CMake. + +# Special rule for the target edit_cache +edit_cache: + @$(CMAKE_COMMAND) -E cmake_echo_color "--switch=$(COLOR)" --cyan "No interactive CMake dialog available..." + /usr/bin/cmake -E echo No\ interactive\ CMake\ dialog\ available. +.PHONY : edit_cache + +# Special rule for the target edit_cache +edit_cache/fast: edit_cache +.PHONY : edit_cache/fast + +# Special rule for the target rebuild_cache +rebuild_cache: + @$(CMAKE_COMMAND) -E cmake_echo_color "--switch=$(COLOR)" --cyan "Running CMake to regenerate build system..." + /usr/bin/cmake --regenerate-during-build -S$(CMAKE_SOURCE_DIR) -B$(CMAKE_BINARY_DIR) +.PHONY : rebuild_cache + +# Special rule for the target rebuild_cache +rebuild_cache/fast: rebuild_cache +.PHONY : rebuild_cache/fast + +# The main all target +all: cmake_check_build_system + $(CMAKE_COMMAND) -E cmake_progress_start /home/richard/code/ray-tracing/CMakeFiles /home/richard/code/ray-tracing//CMakeFiles/progress.marks + $(MAKE) $(MAKESILENT) -f CMakeFiles/Makefile2 all + $(CMAKE_COMMAND) -E cmake_progress_start /home/richard/code/ray-tracing/CMakeFiles 0 +.PHONY : all + +# The main clean target +clean: + $(MAKE) $(MAKESILENT) -f CMakeFiles/Makefile2 clean +.PHONY : clean + +# The main clean target +clean/fast: clean +.PHONY : clean/fast + +# Prepare targets for installation. +preinstall: all + $(MAKE) $(MAKESILENT) -f CMakeFiles/Makefile2 preinstall +.PHONY : preinstall + +# Prepare targets for installation. +preinstall/fast: + $(MAKE) $(MAKESILENT) -f CMakeFiles/Makefile2 preinstall +.PHONY : preinstall/fast + +# clear depends +depend: + $(CMAKE_COMMAND) -S$(CMAKE_SOURCE_DIR) -B$(CMAKE_BINARY_DIR) --check-build-system CMakeFiles/Makefile.cmake 1 +.PHONY : depend + +#============================================================================= +# Target rules for targets named format + +# Build rule for target. +format: cmake_check_build_system + $(MAKE) $(MAKESILENT) -f CMakeFiles/Makefile2 format +.PHONY : format + +# fast build rule for target. +format/fast: + $(MAKE) $(MAKESILENT) -f CMakeFiles/format.dir/build.make CMakeFiles/format.dir/build +.PHONY : format/fast + +#============================================================================= +# Target rules for targets named RayTracer + +# Build rule for target. +RayTracer: cmake_check_build_system + $(MAKE) $(MAKESILENT) -f CMakeFiles/Makefile2 RayTracer +.PHONY : RayTracer + +# fast build rule for target. +RayTracer/fast: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/build +.PHONY : RayTracer/fast + +src/color.o: src/color.cc.o +.PHONY : src/color.o + +# target to build an object file +src/color.cc.o: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/color.cc.o +.PHONY : src/color.cc.o + +src/color.i: src/color.cc.i +.PHONY : src/color.i + +# target to preprocess a source file +src/color.cc.i: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/color.cc.i +.PHONY : src/color.cc.i + +src/color.s: src/color.cc.s +.PHONY : src/color.s + +# target to generate assembly for a file +src/color.cc.s: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/color.cc.s +.PHONY : src/color.cc.s + +src/main.o: src/main.cc.o +.PHONY : src/main.o + +# target to build an object file +src/main.cc.o: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/main.cc.o +.PHONY : src/main.cc.o + +src/main.i: src/main.cc.i +.PHONY : src/main.i + +# target to preprocess a source file +src/main.cc.i: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/main.cc.i +.PHONY : src/main.cc.i + +src/main.s: src/main.cc.s +.PHONY : src/main.s + +# target to generate assembly for a file +src/main.cc.s: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/main.cc.s +.PHONY : src/main.cc.s + +src/vec3.o: src/vec3.cc.o +.PHONY : src/vec3.o + +# target to build an object file +src/vec3.cc.o: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/vec3.cc.o +.PHONY : src/vec3.cc.o + +src/vec3.i: src/vec3.cc.i +.PHONY : src/vec3.i + +# target to preprocess a source file +src/vec3.cc.i: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/vec3.cc.i +.PHONY : src/vec3.cc.i + +src/vec3.s: src/vec3.cc.s +.PHONY : src/vec3.s + +# target to generate assembly for a file +src/vec3.cc.s: + $(MAKE) $(MAKESILENT) -f CMakeFiles/RayTracer.dir/build.make CMakeFiles/RayTracer.dir/src/vec3.cc.s +.PHONY : src/vec3.cc.s + +# Help Target +help: + @echo "The following are some of the valid targets for this Makefile:" + @echo "... all (the default if no target is provided)" + @echo "... clean" + @echo "... depend" + @echo "... edit_cache" + @echo "... rebuild_cache" + @echo "... format" + @echo "... RayTracer" + @echo "... src/color.o" + @echo "... src/color.i" + @echo "... src/color.s" + @echo "... src/main.o" + @echo "... src/main.i" + @echo "... src/main.s" + @echo "... src/vec3.o" + @echo "... src/vec3.i" + @echo "... src/vec3.s" +.PHONY : help + + + +#============================================================================= +# Special targets to cleanup operation of make. + +# Special rule to run CMake to check the build system integrity. +# No rule that depends on this can have commands that come from listfiles +# because they might be regenerated. +cmake_check_build_system: + $(CMAKE_COMMAND) -S$(CMAKE_SOURCE_DIR) -B$(CMAKE_BINARY_DIR) --check-build-system CMakeFiles/Makefile.cmake 0 +.PHONY : cmake_check_build_system + @@ -1 +1,44 @@ -#
\ No newline at end of file +# Ray Tracer + +Inspired by the book _Ray Tracing in One Weekend_, I'd like to write this project using modern C++ (C++ 23) and attempt to use high-performance approaches. + +## Build & Run + +Make Sure your build system is properly set up: +```bash +cmake -S . -B build +``` + +Configure for Release: +```bash +# Release mode +cmake -B build -DCMAKE_BUILD_TYPE=Release +#Debug mode +cmake -B build -DCMAKE_BUILD_TYPE=Debug +``` + +Compile the source code: +```bash +cmake --build build +``` + +To normalize the coding style +```bash +cmake --build build --target format +``` + +Suggests improvements to follow good C++ programming practices: +```bash +cmake --build build --target tidy +cmake --build build --target tidy-all +``` + +Run the program +```bash +./build/apps/RayTracer > images/image.ppm +display images/image.ppm +``` + +## License +This project is licensed under the **GNU General Public License v3.0**. +See the [LICENSE](LICENSE) file for the full text.
\ No newline at end of file diff --git a/apps/CMakeLists.txt b/apps/CMakeLists.txt new file mode 100644 index 0000000..af2d213 --- /dev/null +++ b/apps/CMakeLists.txt @@ -0,0 +1,3 @@ +add_executable(RayTracer main.cc) + +target_link_libraries(RayTracer PRIVATE RayTracerCore)
\ No newline at end of file diff --git a/apps/main.cc b/apps/main.cc new file mode 100644 index 0000000..b0b3aa4 --- /dev/null +++ b/apps/main.cc @@ -0,0 +1,42 @@ +/* + * Copyright (C) 2026 Richard + * + * 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 <https://www.gnu.org/licenses/>. + */ +#include "color.h" +#include "vec3.h" + +#include <iostream> + +int main() +{ + // Image + + const int image_width = 256; + const int image_height = 256; + + // Render + + std::cout << "P3\n" << image_width << " " << image_height << "\n255\n"; + for ( int j = 0; j < image_height; j++ ) { + std::clog << "\rScanlines remaining: " << ( image_height - j ) << ' ' << std::flush; + for ( int i = 0; i < image_width; i++ ) { + auto pixel_color = color( + static_cast<double>( i ) / ( image_width - 1 ), static_cast<double>( j ) / ( image_height - 1 ), 0 ); + write_color( std::cout, pixel_color ); + } + } + std::clog << "\rDone. \n"; + return 0; +}
\ No newline at end of file diff --git a/color.cc b/color.cc deleted file mode 100644 index c1eac72..0000000 --- a/color.cc +++ /dev/null @@ -1,15 +0,0 @@ -#include "color.h" - -void write_color(std::ostream &out, const color &pixel_color){ - auto r = pixel_color.x(); - auto g = pixel_color.y(); - auto b = pixel_color.z(); - - // Translate the [0,1] component values to the byte range [0,255]. - int rbyte = int(255.999 * r); - int gbyte = int(255.999 * g); - int bbyte = int(255.999 * b); - - // Write out the pixel color components. - out << rbyte << ' ' << gbyte << ' ' << bbyte << '\n'; -}
\ No newline at end of file diff --git a/color.h b/color.h deleted file mode 100644 index 23359aa..0000000 --- a/color.h +++ /dev/null @@ -1,12 +0,0 @@ -#ifndef COLOR_H -#define COLOR_H - -#include "vec3.h" - -#include <iostream> - -using color = vec3; - -void write_color(std::ostream &out, const color &pixel_color); - -#endif
\ No newline at end of file diff --git a/etc/build_type.cmake b/etc/build_type.cmake new file mode 100644 index 0000000..69d019f --- /dev/null +++ b/etc/build_type.cmake @@ -0,0 +1,11 @@ +set(default_build_type "Debug") + +if (NOT (CMAKE_BUILD_TYPE_SHADOW STREQUAL CMAKE_BUILD_TYPE)) + if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + message (STATUS "Setting build type to '${default_build_type}'") + set (CMAKE_BUILD_TYPE "${default_build_type}" CACHE STRING "Choose the type of build." FORCE) + endif () + set (CMAKE_BUILD_TYPE_SHADOW ${CMAKE_BUILD_TYPE} CACHE STRING "used to detect changes in build type" FORCE) +endif () + +message (STATUS "Building in '${CMAKE_BUILD_TYPE}' mode.") diff --git a/etc/ccache.cmake b/etc/ccache.cmake new file mode 100644 index 0000000..aeceb8e --- /dev/null +++ b/etc/ccache.cmake @@ -0,0 +1,5 @@ +find_program(CCACHE_PROGRAM ccache) +if(CCACHE_PROGRAM) + set(CMAKE_CXX_COMPILER_LAUNCHER "${CCACHE_PROGRAM}") + message(STATUS "Found ccache: ${CCACHE_PROGRAM} - Compilation will be cached.") +endif()
\ No newline at end of file diff --git a/etc/cflags.cmake b/etc/cflags.cmake new file mode 100644 index 0000000..ac08601 --- /dev/null +++ b/etc/cflags.cmake @@ -0,0 +1,16 @@ +set (CMAKE_CXX_STANDARD 23) +set (CMAKE_EXPORT_COMPILE_COMMANDS ON) + +set(SANITIZING_FLAGS -fno-sanitize-recover=all -fsanitize=undefined -fsanitize=address) + +# ask for more warnings from the compiler +set (CMAKE_BASE_CXX_FLAGS "${CMAKE_CXX_FLAGS}") +set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wpedantic -Wextra -Weffc++ -Werror -Wshadow -Wpointer-arith -Wcast-qual -Wformat=2 -Wno-unqualified-std-cast-call -Wno-non-virtual-dtor") + +# Sanitizers +if(CMAKE_BUILD_TYPE STREQUAL "Debug") + message(STATUS "Enabling Address and Undefined Behavior Sanitizers") + set(SANITIZING_FLAGS "-fno-sanitize-recover=all -fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer") + set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} ${SANITIZING_FLAGS} -g -O0") + set(CMAKE_EXE_LINKER_FLAGS_DEBUG "${CMAKE_EXE_LINKER_FLAGS_DEBUG} ${SANITIZING_FLAGS}") +endif()
\ No newline at end of file diff --git a/etc/lto.cmake b/etc/lto.cmake new file mode 100644 index 0000000..517ec14 --- /dev/null +++ b/etc/lto.cmake @@ -0,0 +1,8 @@ +include(CheckIPOSupported) +check_ipo_supported(RESULT ipo_supported OUTPUT error) +if(ipo_supported) + message(STATUS "IPO / LTO supported and enabled.") + set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE) +else() + message(STATUS "IPO / LTO not supported: <${error}>") +endif()
\ No newline at end of file diff --git a/etc/scanners.cmake b/etc/scanners.cmake new file mode 100644 index 0000000..0a86f19 --- /dev/null +++ b/etc/scanners.cmake @@ -0,0 +1,52 @@ +# file (GLOB_RECURSE RayTracer_CC_FILES ${CMAKE_SOURCE_DIR}/src/*.cc) + +# file (GLOB_RECURSE ALL_SRC_FILES *.hh *.cc) + +# add_custom_target (format "clang-format" -i ${ALL_SRC_FILES} COMMENT "Formatting source code...") + + +find_program(CLANG_FORMAT_EXE clang-format) +if(CLANG_FORMAT_EXE) + file(GLOB_RECURSE ALL_FMT_FILES + "${CMAKE_SOURCE_DIR}/src/*.cc" + "${CMAKE_SOURCE_DIR}/src/*.cpp" + "${CMAKE_SOURCE_DIR}/src/*.h" + "${CMAKE_SOURCE_DIR}/src/*.hpp" + "${CMAKE_SOURCE_DIR}/apps/*.cc" + "${CMAKE_SOURCE_DIR}/apps/*.cpp" + ) + + add_custom_target(format + COMMAND ${CLANG_FORMAT_EXE} -i -style=file ${ALL_FMT_FILES} + COMMENT "Formatting source code..." + ) +else() + message(WARNING "clang-format not found! 'format' target will be disabled.") +endif() + +# clang-tidy +# find_program(CLANG_TIDY_EXE clang-tidy) +# if(CLANG_TIDY_EXE) +# message(STATUS "Clang-Tidy enabled: will run automatically during compilation.") +# set(CMAKE_CXX_CLANG_TIDY "${CLANG_TIDY_EXE}") +# else() +# message(WARNING "clang-tidy not found! Static analysis will be disabled.") +# endif() + +foreach (tidy_target ${ALL_SRC_FILES}) + get_filename_component (basename ${tidy_target} NAME) + get_filename_component (dirname ${tidy_target} DIRECTORY) + get_filename_component (basedir ${dirname} NAME) + set (tidy_target_name "${basedir}__${basename}") + set (tidy_command clang-tidy --quiet -header-filter=.* -p=${PROJECT_BINARY_DIR} ${tidy_target}) + add_custom_target (tidy_${tidy_target_name} ${tidy_command}) + list (APPEND ALL_TIDY_TARGETS tidy_${tidy_target_name}) + + if (${tidy_target} IN_LIST RayTracer_CC_FILES) + list (APPEND RayTracer_TIDY_TARGETS tidy_${tidy_target_name}) + endif () +endforeach (tidy_target) + +add_custom_target (tidy DEPENDS ${RayTracer_TIDY_TARGETS}) + +add_custom_target (tidy-all DEPENDS ${ALL_TIDY_TARGETS}) diff --git a/image.ppm b/images/image.ppm index e88ded1..e88ded1 100644 --- a/image.ppm +++ b/images/image.ppm diff --git a/main.cc b/main.cc deleted file mode 100644 index e9d2e88..0000000 --- a/main.cc +++ /dev/null @@ -1,25 +0,0 @@ -#include <iostream> -#include "vec3.h" -#include "color.h" - -int main() { - // Image - - int image_width = 256; - int image_height = 256; - - // Render - - std::cout << "P3\n" << image_width << " " << image_height << "\n255\n"; - for (int j = 0; j < image_height; j++) - { - std::clog << "\rScanlines remaining: " << (image_height - j) << ' ' << std::flush; - for (int i = 0; i < image_width; i++) - { - auto pixel_color = color(double(i) / (image_width - 1), double(j) / (image_height - 1), 0); - write_color(std::cout, pixel_color); - } - } - std::clog << "\rDone. \n"; - return 0; -}
\ No newline at end of file diff --git a/scripts/make-parallel.sh b/scripts/make-parallel.sh new file mode 100755 index 0000000..879af9a --- /dev/null +++ b/scripts/make-parallel.sh @@ -0,0 +1,2 @@ +#!/bin/sh +exec make -j`nproc` "$@" diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt new file mode 100644 index 0000000..167e18b --- /dev/null +++ b/src/CMakeLists.txt @@ -0,0 +1,8 @@ +set(LIB_SOURCES + vec3.cc + color.cc +) + +add_library(RayTracerCore STATIC ${LIB_SOURCES}) + +target_include_directories(RayTracerCore PUBLIC .)
\ No newline at end of file diff --git a/src/color.cc b/src/color.cc new file mode 100644 index 0000000..9a458bc --- /dev/null +++ b/src/color.cc @@ -0,0 +1,32 @@ +/* + * Copyright (C) 2026 Richard + * + * 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 <https://www.gnu.org/licenses/>. + */ +#include "color.h" + +void write_color( std::ostream& out, const color& pixel_color ) +{ + auto red = pixel_color.x(); + auto green = pixel_color.y(); + auto blue = pixel_color.z(); + + // Translate the [0,1] component values to the byte range [0,255]. + const int rbyte = static_cast<int>( 255.999 * red ); + const int gbyte = static_cast<int>( 255.999 * green ); + const int bbyte = static_cast<int>( 255.999 * blue ); + + // Write out the pixel color components. + out << rbyte << ' ' << gbyte << ' ' << bbyte << '\n'; +}
\ No newline at end of file diff --git a/src/color.h b/src/color.h new file mode 100644 index 0000000..43be7ff --- /dev/null +++ b/src/color.h @@ -0,0 +1,28 @@ +/* + * Copyright (C) 2026 Richard + * + * 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 <https://www.gnu.org/licenses/>. + */ +#ifndef COLOR_H +#define COLOR_H + +#include "vec3.h" + +#include <iostream> + +using color = vec3; + +void write_color(std::ostream &out, const color &pixel_color); + +#endif
\ No newline at end of file diff --git a/src/vec3.cc b/src/vec3.cc new file mode 100644 index 0000000..d01f90a --- /dev/null +++ b/src/vec3.cc @@ -0,0 +1,132 @@ +/* + * Copyright (C) 2026 Richard + * + * 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 <https://www.gnu.org/licenses/>. + */ +#include "vec3.h" + +double vec3::x() const +{ + return e[0]; +} +double vec3::y() const +{ + return e[1]; +} +double vec3::z() const +{ + return e[2]; +} + +vec3 vec3::operator-() const +{ + return { -e[0], -e[1], -e[2] }; +} + +double vec3::operator[]( int i ) const +{ + return e.at( i ); +} + +double& vec3::operator[]( int i ) +{ + return e.at( i ); +} + +vec3& vec3::operator+=( const vec3& other ) +{ + e[0] += other.e[0]; + e[1] += other.e[1]; + e[2] += other.e[2]; + return *this; +} + +vec3& vec3::operator*=( double t ) +{ + e[0] *= t; + e[1] *= t; + e[2] *= t; + return *this; +} + +vec3& vec3::operator/=( double t ) +{ + return *this *= 1 / t; +} + +double vec3::length() const +{ + return std::sqrt( length_squared() ); +} + +double vec3::length_squared() const +{ + return e[0] * e[0] + e[1] * e[1] + e[2] * e[2]; +} + +// point3 is just an alias for vec3, but useful for geometric clarity in the code. +using point3 = vec3; + +// Vector Utility Functions + +inline std::ostream& operator<<( std::ostream& out, const vec3& v ) +{ + return out << v.e[0] << ' ' << v.e[1] << ' ' << v.e[2]; +} + +inline vec3 operator+( const vec3& u, const vec3& v ) +{ + return { u.e[0] + v.e[0], u.e[1] + v.e[1], u.e[2] + v.e[2] }; +} + +inline vec3 operator-( const vec3& u, const vec3& v ) +{ + return { u.e[0] - v.e[0], u.e[1] - v.e[1], u.e[2] - v.e[2] }; +} + +inline vec3 operator*( const vec3& u, const vec3& v ) +{ + return { u.e[0] * v.e[0], u.e[1] * v.e[1], u.e[2] * v.e[2] }; +} + +inline vec3 operator*( double t, const vec3& v ) +{ + return { t * v.e[0], t * v.e[1], t * v.e[2] }; +} + +inline vec3 operator*( const vec3& v, double t ) +{ + return t * v; +} + +inline vec3 operator/( const vec3& v, double t ) +{ + return ( 1 / t ) * v; +} + +inline double dot( const vec3& u, const vec3& v ) +{ + return u.e[0] * v.e[0] + u.e[1] * v.e[1] + u.e[2] * v.e[2]; +} + +inline vec3 cross( const vec3& u, const vec3& v ) +{ + return { + u.e[1] * v.e[2] - u.e[2] * v.e[1], u.e[2] * v.e[0] - u.e[0] * v.e[2], u.e[0] * v.e[1] - u.e[1] * v.e[0] }; +} + +inline vec3 unit_vector( const vec3& v ) +{ + return v / v.length(); +} @@ -1,12 +1,29 @@ +/* + * Copyright (C) 2026 Richard + * + * 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 <https://www.gnu.org/licenses/>. + */ #ifndef VEC_3 #define VEC_3 +#include <array> #include <cmath> #include <iostream> class vec3{ public: - double e[3]; + std::array<double, 3> e; vec3() : e{0, 0, 0} {} vec3(double e0, double e1, double e2) : e{e0, e1, e2} {} diff --git a/vec3.cc b/vec3.cc deleted file mode 100644 index 38844c7..0000000 --- a/vec3.cc +++ /dev/null @@ -1,105 +0,0 @@ -#include "vec3.h" - -double vec3::x() const { return e[0]; } -double vec3::y() const { return e[1]; } -double vec3::z() const { return e[2]; } - -vec3 vec3::operator-() const { - return vec3(-e[0], -e[1], -e[2]); -} - -double vec3::operator[](int i) const{ - return e[i]; -} - -double& vec3::operator[](int i){ - return e[1]; -} - -vec3& vec3::operator+=(const vec3 &v) -{ - e[0] += v.e[0]; - e[1] += v.e[1]; - e[2] += v.e[2]; - return *this; -} - -vec3& vec3::operator*=(double t) -{ - e[0] *= t; - e[1] *= t; - e[2] *= t; - return *this; -} - -vec3& vec3::operator/=(double t) -{ - return *this *= 1 / t; -} - -double vec3::length() const -{ - return std::sqrt(length_squared()); -} - -double vec3::length_squared() const -{ - return e[0] * e[0] + e[1] * e[1] + e[2] * e[2]; -} - -// point3 is just an alias for vec3, but useful for geometric clarity in the code. -using point3 = vec3; - -// Vector Utility Functions - -inline std::ostream &operator<<(std::ostream &out, const vec3 &v) -{ - return out << v.e[0] << ' ' << v.e[1] << ' ' << v.e[2]; -} - -inline vec3 operator+(const vec3 &u, const vec3 &v) -{ - return vec3(u.e[0] + v.e[0], u.e[1] + v.e[1], u.e[2] + v.e[2]); -} - -inline vec3 operator-(const vec3 &u, const vec3 &v) -{ - return vec3(u.e[0] - v.e[0], u.e[1] - v.e[1], u.e[2] - v.e[2]); -} - -inline vec3 operator*(const vec3 &u, const vec3 &v) -{ - return vec3(u.e[0] * v.e[0], u.e[1] * v.e[1], u.e[2] * v.e[2]); -} - -inline vec3 operator*(double t, const vec3 &v) -{ - return vec3(t * v.e[0], t * v.e[1], t * v.e[2]); -} - -inline vec3 operator*(const vec3 &v, double t) -{ - return t * v; -} - -inline vec3 operator/(const vec3 &v, double t) -{ - return (1 / t) * v; -} - -inline double dot(const vec3 &u, const vec3 &v) -{ - return u.e[0] * v.e[0] + u.e[1] * v.e[1] + u.e[2] * v.e[2]; -} - -inline vec3 cross(const vec3 &u, const vec3 &v) -{ - return vec3(u.e[1] * v.e[2] - u.e[2] * v.e[1], - u.e[2] * v.e[0] - u.e[0] * v.e[2], - u.e[0] * v.e[1] - u.e[1] * v.e[0]); -} - -inline vec3 unit_vector(const vec3 &v) -{ - return v / v.length(); -} |
