The flexibility to extend the emulation velocity of the Citra emulator on Android units is a big function that enables customers to expertise Nintendo 3DS video games at a extra fluid and responsive tempo. This performance manipulates the inner clock of the emulation, successfully accelerating the sport’s perceived velocity. For example, a consumer would possibly make use of this function to bypass prolonged cutscenes or to expedite gameplay sections requiring repetitive actions.
This acceleration functionality is especially essential for enhancing the consumer expertise on cell units, the place processing energy could also be restricted in comparison with desktop computer systems. It mitigates efficiency bottlenecks and makes beforehand unplayable or sluggish video games extra accessible. Traditionally, emulator builders have integrated comparable options to beat {hardware} limitations and enhance general recreation enjoyment.
The following sections will delve into the technical concerns, efficiency implications, and potential drawbacks related to modifying emulation velocity on the Android model of the aforementioned emulator, providing a balanced perspective on its sensible utility.
1. Pace enhancement performance
Pace enhancement performance, as utilized throughout the context of the Citra emulator on Android, represents the core mechanism by which customers obtain accelerated gameplay. This performance straight impacts the speed at which the emulator processes recreation logic, graphics rendering, and audio output, successfully simulating the sport at a velocity exceeding its authentic design. The affect of that is evident in conditions the place customers want to cut back the time spent on non-interactive cutscenes or navigate expansive recreation worlds extra quickly. For example, in role-playing video games with intensive dialogue sequences, the accelerated velocity can considerably lower the time funding required to progress by way of the narrative.
The technical implementation of velocity enhancement usually entails modifying the emulator’s inner clock or adjusting the timing of its execution loops. Nevertheless, this alteration shouldn’t be with out potential penalties. Rising the emulation velocity can introduce instability, graphical glitches, or audio desynchronization, notably on lower-powered Android units. The effectiveness of velocity enhancement is contingent upon the gadget’s processing capabilities and the complexity of the sport being emulated. Sure demanding titles might exhibit vital efficiency degradation and even turn into unplayable at greater speeds.
In abstract, velocity enhancement constitutes a vital element of the Citra Android expertise, providing customers the potential to customise their gameplay tempo. Nevertheless, the utilization of this function necessitates cautious consideration of the trade-offs between velocity and stability. The optimum velocity setting will differ relying on the sport and the {hardware}, requiring customers to experiment to realize a steadiness that maximizes enjoyment whereas minimizing adverse negative effects.
2. Efficiency optimization necessity
Efficiency optimization is a prerequisite for efficient utilization of accelerated emulation on Citra for Android. The inherent calls for of 3DS emulation on cell {hardware} typically necessitate a sequence of changes to realize acceptable body charges, even earlier than contemplating velocity enhancements. Absent correct optimization, forcing an elevated emulation velocity dangers pushing the gadget past its capabilities, leading to body price drops, stuttering, and potential crashes. For example, trying to speed up a graphically intensive recreation like The Legend of Zelda: Ocarina of Time 3D on a low-end Android gadget with none prior optimization will doubtless end in an unplayable expertise. Efficiency optimization serves to offer a baseline of stability, enabling velocity enhancement to be employed judiciously and successfully.
The connection between optimization and velocity enhancement manifests in a number of sensible methods. Optimization strategies, equivalent to adjusting rendering decision, disabling pointless graphical results, and configuring CPU emulation settings, cut back the general processing load. This, in flip, frees up assets that may then be leveraged to assist elevated emulation velocity. Moreover, profiling instruments can establish particular bottlenecks inside a recreation’s emulation, permitting for focused optimization efforts. By addressing these bottlenecks, the emulator turns into extra environment friendly, able to sustaining greater speeds with out vital efficiency degradation. Contemplate a situation the place a recreation’s shadow rendering is especially demanding; disabling shadows would possibly permit for a considerable enhance in emulation velocity with out sacrificing general playability.
In abstract, efficiency optimization kinds the inspiration upon which profitable accelerated emulation is constructed. With out it, the try and run Citra at elevated speeds on Android units is liable to failure. Understanding the connection between optimization and velocity enhancement is important for customers in search of to boost their gaming expertise. Balancing visible constancy with efficiency and making use of acceptable optimization strategies permits for a extra secure and pleasant utilization of the velocity enhancement function, mitigating the inherent challenges of 3DS emulation on cell platforms. The combination of velocity enhancement will depend on how effectively the system is optimized.
3. {Hardware} useful resource demand
The performance to speed up the perceived velocity of video games throughout the Citra emulator on Android units locations a considerably amplified demand on system {hardware} assets. This acceleration inherently requires the processor and graphics processing unit to carry out a higher variety of calculations per unit of time in comparison with normal emulation. Because the velocity multiplier will increase, the computational workload escalates correspondingly, doubtlessly exceeding the capabilities of the gadget. An actual-world instance entails graphically intensive video games: trying to speed up their execution with out adequate processing energy ceaselessly results in efficiency instability, characterised by drastic body price drops, audio stuttering, or full utility crashes. Consequently, {hardware} useful resource demand serves as a limiting issue within the efficient utilization of accelerated emulation.
The precise {hardware} parts most impacted by elevated emulation velocity embrace the central processing unit (CPU), which manages recreation logic and emulation processes, and the graphics processing unit (GPU), which renders the visible output. The random entry reminiscence (RAM) additionally performs a vital function, storing recreation information and emulator directions. Elevated emulation speeds necessitate sooner information entry and processing, straining these parts. Some older or lower-end Android units lack the required processing or thermal capability to maintain accelerated emulation over extended intervals, leading to overheating and throttling of efficiency. This results in a paradoxical scenario the place the meant velocity enhance is negated by the system’s protecting mechanisms. The out there storage can also be an element since excessive velocity operations might enhance the scale of momentary recordsdata or cached information.
In conclusion, a radical understanding of {hardware} useful resource demand is essential when contemplating accelerated emulation inside Citra on Android. It dictates the feasibility and effectiveness of this performance. With out adequate processing energy, graphics capabilities, and reminiscence assets, the potential advantages of accelerated emulation are diminished, and the consumer expertise could also be negatively impacted. Prioritizing {hardware} compatibility and thoroughly managing the emulation velocity relative to the gadget’s capabilities are important for reaching a steadiness between efficiency and stability.
4. Recreation stability affect
The manipulation of emulation velocity throughout the Citra emulator on Android straight influences recreation stability, constituting a big consideration for customers in search of to boost efficiency. Accelerated execution introduces complexities that may disrupt the meant habits of the emulated software program, doubtlessly main to numerous types of instability.
-
Timing-Delicate Operations
Many video games depend on exact timing for core capabilities equivalent to physics calculations, animation sequences, and occasion triggers. When the emulation velocity is elevated, these timing dependencies will be disrupted. For example, a puzzle mechanic requiring exact button presses inside a slender time window might turn into unsolvable as a result of accelerated recreation clock. Equally, scripted occasions important for development would possibly fail to set off if the required situations usually are not met throughout the adjusted timeframe. The modification of execution velocity can thereby undermine the inherent design of the sport, inflicting development blocks and useful errors.
-
Useful resource Administration Errors
Emulation at elevated speeds will increase the demand on system assets, inserting further pressure on reminiscence administration and thread synchronization. Inadequate dealing with of those assets may end up in reminiscence leaks, information corruption, or deadlocks. For instance, a recreation would possibly allocate reminiscence for a selected process, however the elevated processing velocity prevents it from being launched in a well timed method, finally resulting in a reminiscence overflow and utility crash. Equally, conflicts between threads trying to entry shared assets concurrently can result in unpredictable habits and program termination. Inadequacies in useful resource administration exacerbated by elevated emulation velocity severely compromise recreation stability.
-
Compatibility Discrepancies
Whereas some video games might tolerate and even profit from accelerated emulation, others exhibit elevated susceptibility to instability. Video games with intricate coding or these pushing the unique {hardware} to its limits are notably susceptible. A recreation that runs flawlessly at regular velocity might exhibit graphical glitches, audio distortion, or outright crashes when the emulation velocity is elevated. This stems from the emulator struggling to precisely interpret and execute the sport’s directions throughout the altered timeframe. Testing the compatibility and stability of a selected recreation at numerous speeds turns into important to find out the suitability of the velocity enhancement function.
-
Save Knowledge Corruption
The alteration of emulation velocity can, in sure circumstances, introduce the danger of save information corruption. If the sport’s saving mechanisms are disrupted by the modified timing or useful resource allocation, the saved progress might turn into irretrievable. For instance, if the emulator is interrupted throughout the saving course of because of instability or a crash, the save file could also be rendered unusable. This constitutes a extreme consequence for customers who’ve invested vital effort and time right into a recreation. Frequently backing up save information offers a safeguard towards potential information loss ensuing from instability associated to accelerated emulation.
The varied aspects of stability affect underscore the necessity for warning when using velocity enhancements inside Citra on Android. The advantages of accelerated gameplay should be weighed towards the potential for introducing instability, graphical errors, information corruption, and useful issues. Cautious experimentation and thorough testing are required to realize a steadiness between velocity and stability that preserves the integrity of the gaming expertise.
5. Audio desynchronization potential
The potential for audio desynchronization represents a tangible consequence of accelerating emulation velocity throughout the Citra setting on Android platforms. This phenomenon arises from the disparate dealing with of audio and video processing pipelines throughout velocity enhancement. The emulator, when compelled to function at the next clock price, might prioritize the rendering of visible frames over the correct timing and synchronization of audio output. Consequently, the auditory element of the sport drifts out of alignment with the visible show, making a disjointed and doubtlessly disruptive consumer expertise. An illustrative instance is observing a personality’s lips shifting out of sync with the spoken dialogue, or listening to a sound impact triggered both prematurely or belatedly relative to the corresponding on-screen occasion. Audio desynchronization, due to this fact, considerably degrades the immersive high quality of the emulated recreation.
The prevalence of audio desynchronization is commonly exacerbated by {hardware} limitations current in cell units. Diminished processing energy and reminiscence bandwidth in comparison with desktop programs constrain the emulator’s potential to keep up excellent synchronization between audio and video streams when working at accelerated speeds. Moreover, sure audio codecs or rendering strategies employed by the emulator could also be extra inclined to timing errors below elevated computational load. Mitigating this challenge requires cautious balancing of the emulation velocity with the gadget’s capabilities, doubtlessly involving compromises in visible constancy or body price to protect audio synchronization. Superior emulator configurations might provide choices for adjusting audio buffering or synchronization strategies, however these options typically demand a deeper understanding of the underlying technical processes.
In conclusion, audio desynchronization constitutes a notable problem related to accelerated emulation on Citra for Android. It arises from the complicated interaction between emulation velocity, {hardware} constraints, and audio processing strategies. Addressing this challenge necessitates a multifaceted method, encompassing each considered choice of emulation parameters and a essential evaluation of the gadget’s efficiency traits. Whereas full elimination of audio desynchronization might not at all times be achievable, a radical understanding of its underlying causes permits for knowledgeable choices that decrease its disruptive affect on the consumer expertise.
6. Graphical artifact prevalence
Accelerated emulation, as applied throughout the Citra emulator on Android, reveals a direct correlation with the prevalence of graphical artifacts. These visible anomalies manifest as distortions, lacking textures, or incorrect rendering of recreation components, successfully compromising the meant visible presentation. The first trigger stems from the emulator’s elevated processing velocity, which may outpace the gadget’s capability to precisely carry out complicated graphical calculations. For instance, a racing recreation would possibly exhibit flickering textures on automobile fashions, or a personality animation may show disjointed limbs because of incorrect skeletal rendering. The emergence of graphical artifacts is a crucial indicator of instability throughout the accelerated emulation setting, and understanding this connection is essential for reaching a steadiness between efficiency and visible constancy.
The importance of graphical artifact prevalence extends to sensible concerns associated to consumer expertise and recreation playability. A excessive frequency of visible anomalies can severely detract from the immersive high quality of the sport, rendering it unplayable or unenjoyable. Additional, sure sorts of artifacts, equivalent to display screen tearing or rendering errors affecting essential recreation components, can straight impede gameplay progress. For example, a puzzle recreation would possibly turn into unsolvable if a key visible clue is obscured by a graphical glitch. Subsequently, the detection and mitigation of graphical artifacts represents a elementary facet of optimizing the accelerated emulation expertise. This typically entails adjusting emulator settings, equivalent to rendering decision or filtering choices, to prioritize visible accuracy over uncooked velocity. Some recreation titles can tolerate the acceleration of velocity, some usually are not.
In conclusion, graphical artifact prevalence is an inherent problem related to accelerated emulation in Citra on Android. These visible distortions come up from the elevated computational calls for positioned on the gadget’s graphics processing capabilities. Acknowledging the connection between velocity enhancement and artifact era is crucial for knowledgeable decision-making relating to emulation settings. Mitigation methods contain a cautious balancing act between efficiency good points and visible integrity, aiming to reduce the prevalence of artifacts whereas sustaining an appropriate stage of velocity enhancement. The problem stays ongoing, requiring steady optimization efforts to enhance the visible high quality of emulated video games on Android platforms.
7. Battery consumption enhance
The accelerated execution of recreation emulation throughout the Citra setting on Android units straight correlates with a discernible enhance in battery consumption. This stems from the heightened demand positioned on the gadget’s central processing unit (CPU) and graphics processing unit (GPU) when working at speeds exceeding the meant design parameters of the emulated software program. Because the system endeavors to render frames and course of recreation logic at an accelerated price, energy draw from the battery escalates considerably. A sensible illustration entails prolonged gameplay classes: a consumer would possibly observe a considerable discount in remaining battery capability when using velocity enhancement options in comparison with enjoying the identical recreation at its authentic velocity. Consequently, battery consumption enhance represents a vital issue to contemplate when using velocity acceleration on cell units.
The significance of monitoring battery depletion throughout accelerated emulation extends to mitigating potential {hardware} degradation and guaranteeing extended gadget lifespan. Sustained operation at elevated processing hundreds can generate substantial warmth, doubtlessly affecting battery well being and general system stability. Energy administration methods, equivalent to limiting the velocity enhancement issue or using energy-saving modes, provide a way of addressing these issues. Moreover, using exterior energy sources or moveable battery packs offers a sensible answer for extending gameplay period with out depleting the gadget’s inner battery. Particular video games will have an effect on energy consumption greater than others, relying on the graphical demand and required computing.
In abstract, elevated battery consumption is an intrinsic consequence of accelerated recreation emulation on Android units. Understanding the underlying mechanisms driving this phenomenon, together with implementing acceptable energy administration strategies, is crucial for optimizing the consumer expertise and preserving gadget integrity. Vigilant monitoring of battery ranges and proactive adoption of mitigation methods serve to mitigate the potential opposed results of velocity enhancement on battery life and general system efficiency.
8. Consumer expertise modification
Accelerated emulation by way of the Citra utility on Android units straight modifies the consumer expertise, altering the tempo and really feel of gameplay in comparison with the unique meant design. This modification encompasses each optimistic and adverse features. On one hand, it permits customers to bypass prolonged cutscenes, expedite grinding sections, or overcome synthetic problem stemming from sluggish character motion. However, it could actually disrupt the meant pacing of the narrative, introduce surprising gameplay challenges because of altered timing, and affect the general immersion. The intentional alteration of recreation velocity represents a deliberate modification of the consumer expertise, prioritizing effectivity or private desire over the genuine recreation of the unique gaming setting. An instance is dashing up a slow-paced RPG’s exploration components to make it extra pleasant, nonetheless the immersion could also be impacted.
The importance of consumer expertise modification lies in its subjectivity. Whereas some customers might prioritize velocity and effectivity, others might worth the genuine expertise. The supply of accelerated emulation affords a level of management over this facet, permitting customers to tailor their expertise to their particular person preferences. Nevertheless, the uncritical utility of velocity enhancement can inadvertently detract from the sport’s meant design. It’s essential, due to this fact, that customers train discernment when modifying the sport velocity, understanding the potential implications for gameplay, narrative, and general enjoyment. The implementation might have an effect on the power for the gamer to play appropriately, so the tip results of the method could also be adverse quite than optimistic.
In conclusion, consumer expertise modification is an inherent final result of using accelerated emulation inside Citra on Android. The deliberate alteration of recreation velocity introduces each alternatives and challenges, requiring customers to rigorously weigh the potential advantages towards the danger of disrupting the meant gaming expertise. The important thing perception is to grasp that accelerated emulation is a device for modifying the consumer expertise, and like several device, it ought to be used judiciously and with a transparent understanding of its potential penalties. Challenges relate to consumer understanding and management, and broader hyperlinks embrace customization and accessibility in cell gaming.
9. Compatibility variability
Compatibility variability represents a big problem when using accelerated emulation throughout the Citra utility on Android units. The profitable implementation of the aforementioned performance is contingent upon a spread of things that contribute to inconsistencies throughout completely different recreation titles and {hardware} configurations. Understanding the sources of compatibility variability is crucial for predicting and mitigating potential points throughout accelerated emulation.
-
Recreation-Particular Code Optimization
Particular person recreation titles typically make use of distinctive code optimization strategies tailor-made to the unique Nintendo 3DS {hardware}. The Citra emulator, whereas designed to offer a generalized emulation setting, might not completely interpret or execute these optimizations at accelerated speeds. Consequently, sure video games might exhibit elevated stability or efficiency in comparison with others when the emulation velocity is elevated. Video games making intensive use of customized meeting code, for instance, may current higher challenges for correct emulation, doubtlessly resulting in graphical glitches or instability at greater speeds. The reliance on distinctive software program strategies straight influences emulation accuracy and stability.
-
{Hardware} Structure Divergence
Android units embody a various vary of {hardware} architectures, together with completely different CPU designs, GPU fashions, and reminiscence configurations. This variability influences the emulator’s efficiency and compatibility with particular person recreation titles. A recreation that runs easily on a high-end gadget with a strong GPU might exhibit vital efficiency points or instability on a lower-end gadget. The inherent limitations of particular {hardware} parts can prohibit the power to realize accelerated emulation with out compromising stability, straight impacting how the software program operates.
-
Emulator Model and Configuration
Completely different variations of the Citra emulator might incorporate various ranges of optimization and bug fixes that have an effect on compatibility with particular recreation titles. Moreover, user-configurable settings, equivalent to rendering decision and CPU emulation mode, can affect each efficiency and stability. Using older emulator variations or suboptimal configurations might exacerbate compatibility points, notably when trying to speed up emulation speeds. The continual growth and refinement of the emulator software program are important to bettering compatibility and addressing efficiency challenges, thereby straight affecting the output for customers.
-
Useful resource Depth of Recreation Parts
The person components and sections that type a recreation would require computing assets. Some components could also be easy, and due to this fact take fewer assets, whereas others would require considerably extra. As a result of the efficiency of this perform is extremely depending on computing useful resource wants, a recreation might run efficiently for lengthy intervals and all of a sudden have a dramatic degradation of perform. These useful resource spikes are tough to foretell, because it will depend on a fancy interplay between the system, code and recreation capabilities.
The interaction of game-specific code, {hardware} divergence, emulator configuration, and the various computing assets required of recreation components collectively contributes to compatibility variability in accelerated emulation. Understanding these elements is crucial for troubleshooting efficiency points and optimizing the Citra expertise on Android units. The profitable implementation of velocity enhancement options necessitates cautious consideration of those components to realize a steadiness between efficiency good points and sustaining a secure and pleasant gaming expertise. Compatibility points should be thought-about whereas optimizing the emulation.
Steadily Requested Questions
This part addresses widespread inquiries relating to the performance to extend emulation velocity within the Citra emulator on Android units. The knowledge supplied goals to make clear the capabilities, limitations, and potential implications of this function.
Query 1: What is supposed by “Citra Android Quick Ahead”?
The time period refers back to the potential to extend the emulation velocity throughout the Citra emulator on Android units past its regular price. This permits video games to run sooner than initially designed, doubtlessly bypassing sluggish sections or accelerating gameplay.
Query 2: What are the potential advantages of using the “Quick Ahead” function?
The first profit is diminished gameplay time by accelerating slow-paced sections, minimizing wait instances, and skipping repetitive actions. It may enhance consumer engagement, particularly on cell units the place shorter classes are most well-liked.
Query 3: What are the potential drawbacks of accelerating emulation velocity?
Rising emulation velocity might result in instability, graphical glitches, audio desynchronization, and elevated battery consumption. Some video games might turn into unplayable at greater speeds. Compatibility variability impacts the general efficiency of the system.
Query 4: Is it potential to make use of this performance on any Android gadget?
The feasibility will depend on the gadget’s {hardware} capabilities. Larger-end units with extra highly effective processors and graphics capabilities will usually present a greater expertise in comparison with lower-end units.
Query 5: How does one correctly alter “quick ahead” settings to maximise efficiency?
Incremental changes are beneficial. Begin with a modest enhance and monitor efficiency and stability. Experiment to seek out the optimum steadiness between velocity and stability for every recreation and {hardware} configuration.
Query 6: Does this performance have an effect on save information or recreation development?
Whereas usually secure, there exists a possible threat of save information corruption if the emulator crashes or encounters an error throughout the saving course of whereas working at an accelerated velocity. Common backups of save information are inspired.
This FAQ offers a normal overview of the “Citra Android Quick Ahead” function. Accountable and knowledgeable utilization of this performance enhances the emulation expertise.
The following part will delve into particular troubleshooting methods and beneficial configuration settings for optimizing accelerated emulation on Android units.
Citra Android Quick Ahead
The next pointers present actionable suggestions for maximizing efficiency and minimizing opposed results when accelerating emulation velocity inside Citra on Android units. These suggestions are primarily based on noticed habits and goal to enhance stability and consumer expertise.
Tip 1: Incrementally Modify Pace Multiplier: Keep away from aggressive will increase in emulation velocity. Begin with small increments (e.g., 1.25x, 1.5x) and step by step enhance till efficiency degradation or instability is noticed. This incremental method facilitates identification of the optimum velocity multiplier for a given recreation and {hardware} configuration.
Tip 2: Prioritize Optimization Earlier than Acceleration: Make sure that the emulator is configured for optimum efficiency earlier than trying to extend emulation velocity. This consists of deciding on acceptable rendering decision, disabling pointless graphical results (e.g., shadows, post-processing), and configuring CPU emulation settings for optimum efficiency. Correct optimization offers a secure baseline for accelerated emulation.
Tip 3: Monitor System Temperature and Battery Degree: Accelerated emulation locations elevated stress on the gadget’s {hardware}, doubtlessly resulting in overheating and accelerated battery drain. Frequently monitor gadget temperature and battery stage throughout prolonged gameplay classes. Make use of power-saving modes or exterior energy sources as wanted to mitigate these results.
Tip 4: Experiment with Completely different Emulator Variations: Compatibility and efficiency can differ considerably between completely different variations of the Citra emulator. Experiment with completely different variations to establish the one that gives the perfect steadiness of efficiency and stability for a selected recreation and {hardware} configuration. Seek the advice of group boards for suggestions on optimum emulator variations for particular titles.
Tip 5: Make the most of Body Skip Strategically: Body skipping, a way that sacrifices visible smoothness for improved efficiency, will be employed to alleviate efficiency bottlenecks throughout accelerated emulation. Nevertheless, extreme body skipping can negatively affect the visible expertise. Implement body skipping judiciously, prioritizing a steadiness between efficiency and visible high quality.
Tip 6: Shut Background Functions: Make sure that all pointless background functions are closed earlier than launching the Citra emulator. Background processes eat system assets that would in any other case be allotted to emulation, doubtlessly bettering efficiency and stability.
Tip 7: Analysis Recreation-Particular Compatibility: Seek the advice of on-line boards and compatibility lists to establish recognized points and beneficial settings for particular recreation titles. This will save effort and time in troubleshooting efficiency issues and maximizing stability.
Adherence to those suggestions promotes a extra secure and pleasant accelerated emulation expertise inside Citra on Android. By prioritizing optimization, monitoring system efficiency, and adapting settings primarily based on particular person recreation and {hardware} traits, customers can mitigate potential points and maximize the advantages of this performance.
The following part offers a conclusion summarizing key findings and providing future views on accelerated emulation inside cell environments.
Conclusion
This exploration of the “Citra Android Quick Ahead” function reveals a fancy interaction between efficiency enhancement and potential compromises. The capability to speed up emulation velocity affords simple advantages, together with diminished gameplay period and elevated consumer engagement. Nevertheless, the implementation of this performance introduces challenges associated to stability, graphical integrity, audio synchronization, and {hardware} useful resource administration. Profitable utilization necessitates a radical understanding of those elements and a willingness to experiment with numerous configuration settings to realize an optimum steadiness.
Finally, the accountable and knowledgeable utility of “Citra Android Quick Ahead” represents a beneficial device for enhancing the cell gaming expertise. As cell {hardware} continues to advance and emulator expertise evolves, the potential for seamless and secure accelerated emulation will undoubtedly broaden, additional enriching the panorama of cell gaming. Additional investigation into particular recreation titles is required to boost the function.
